I would like to ask if there is any documentation in your team? What content needs special documentation to record?

I have been writing programs from scratch in a startup company for more than a year. Now my boss wants to document it so that newcomers can quickly get started with the project. I don’t know what should be written in the document. Maybe it’s too much. After a while, the code was changed by other colleagues, and the documentation was incorrect. Should I write documentation? What should I write? Or is there a better way?

Reply content:

I have been writing programs from scratch in a startup company for more than a year. Now my boss wants to document it so that newcomers can quickly get started with the project. I don’t know what should be written in the document. Maybe it’s too much. After a while, the code was changed by other colleagues, and the documentation was incorrect. Should I write documentation? What should I write? Or is there a better way?

1. Code modification record

2. Database modification record

3. Problems and solutions

4. If colleagues make modifications, ask them to update to the back of the document instead of replacing it directly

I think it’s better to first explain the basic processes and specifications of the company’s projects. For example, newcomers may not necessarily know some of the company’s previous work records, and may end up duplicating work and messing around. You can first briefly explain the basic introduction and related links of some tools, frameworks, and platforms used in the company's projects; then the company's coding standards, basic business, work plans (Todo), and code management; and then the problems encountered during the work process. Some problems and solutions are mentioned to prevent newbies from continuing to fall into the trap; finally, you can recommend to novices some technology stacks that the company's business may involve and need to learn about.

php open source DokuWiki

This was originally a pitfall. I didn’t write it when I was developing it, so I’m writing it now.
But I can give you some references:
System design documents, database design documents, interface design documents, website deployment configuration documents, website usage instructions documents, etc.