Technical documentation, how and what to write?

Question

Documentation

I am a developer on a large project. The project consists of many interconnected parts working on different technologies. I was tasked with writing technical documentation for the project. I have experience documenting APIs, but I've never been involved in documenting an entire project. I do not know what should and what should not be described. Where to begin? Please share your experience and suggest high-quality literature / articles on this topic, if any. I read several articles on Habré, but they did not give answers to my questions.

Answer 1

First, there are many regulations for different types of software in different countries. Secondly, the description should include a textual description (goals\problems\solutions), uml\bpmn2 diagrams describing the architecture\design\scenarios. Thirdly, creating a technical description of a product is much more difficult than creating the product itself, since it is the same only in other languages ​​and in more detail. It is comparable to a book, sometimes thousands of pages long.
To create, just a huge bunch of tools are used, each of which you just can’t master like that, you need to read and memorize a lot.
And in general, this is done either immediately (this is inherent in very cool outsourcing companies for which this is not the first experience, which means that most of the necessary declarations are on hand), or throughout the life of the product by the whole team, since one person simply cannot master this.