How to write technical documentation for software?

Question

Programming

Good afternoon experts!
Problem
There is a written program. It is necessary to write technical documentation for it. Since the project is completed, and in case it is resumed after some time, I did not have to study the code like the first time.
Questions :

1. Are there any methodologies for writing documentation?
   
2. Are there any convenient (paid, bourgeois) SAAS services to simplify documentation?
   
3. I didn’t find much information on writing documentation, tell me queries on which I can “dig up” more information on this issue, or point to specific resources / articles?
   
4. What is the name of the profession of people who are only engaged in writing documentation?
   
5. What is the average cost of the work of people writing documentation?
   

Thank you.

Answer 1

Here , please. We set on the source and fill in the gaps in the description / comments.

Answer 2

What is the name of the profession of people who are only engaged in writing documentation?

The profession is called Technical Writer . I can suggest starting with the links at the end of the wikipedia article.

Answer 3

You can remember coursework on programming.
As it was in our educational institution, the documentation is divided into 2 parts.
1. General
2. Special
General - describes the software used for product development.
Special part - describes all parts of the program. Macro flowchart, Block diagrams of problem areas. Program listing. Description of each function, its types, etc. etc. ER-diagram, connection of database tables. How many fields are in the table, each field of the table is described, its type, etc., etc.
Perhaps the standards are different.

Answer 4

The main issue is the size of the project.
If there are up to 3 thousand lines, then there will be enough good xml comments on classes and methods.
If there is a lot of code, then at least the architecture is needed (who depends on whom, who is responsible for what, etc.), plus tests always help me, if any.

Answer 5

Are there any methodologies for writing documentation?
Yes. In your case, you can write according to GOST 19. If the project is large, then according to GOST 34. There are ISO standards
Are there any convenient (paid, bourgeois) SAAS services to simplify documentation?
For example, WIki can store it.
I didn’t find much information on writing documentation, tell me queries on which I can “dig up” more information on this issue, or point to specific resources / articles?
In your case, these are: technical documentation, API description, database description, Javadoc, Doxygen
What is the name of the profession of people who only write documentation?
Technical writers, techwriters, documentation developers.
What is the average cost of the work of people writing documentation?
The salary of a technical writer is highly dependent on qualifications, on the language in which he writes, as well as on the complexity of the project and the type of documentation. We can say that from 30 to 100 thousand per month.

Answer 6

Are there any methodologies for writing documentation?

For government customers - GOST (19, 34). In common practice - ISO, "simplified guest", etc.
Spelling in the sense of "hands" or "recoil" (generation)?
You better formulate what you need. It will be easier to answer. For example, first read these posts:
https://toster.ru/answer?answer_id=658763
https://toster.ru/answer?answer_id=658771
and specify your task.
I agree with the previous participant.
It all depends on the options: region? in state/out of state? volume? document creation language? skills?

Answer 7

https://cms.skeeks.com/community/blog/322-kak-pisa... - here you can see one of the options