Documentation and Review of Software Development

Software development must be procedural and must be aided by documentation. There is no doubt that documents need to be written, including: requirements analysis documents, design documents, etc. However, project teams that have not done this often fail to grasp the key points and go into some misunderstandings.

1. There is no large and comprehensive template

There is no large and comprehensive document template, and the document can be written according to the template. Software development itself is a cognitive and design process. The content of the document is the result of cognition and design. How is it possible to have a template in advance telling you what to write without cognition and design happening.

Templates provide at most one fixed document form. But what to have and how to organize this is up to the person who wrote the documentation. Form is for content.

The document template can serve as a reminder, but it's secondary. The key is content.

Templates are obviously not very useful if you can grasp what you want to write.

2. The focus of the review is the content The first

review is the correctness of the content. For example: whether the user needs are grasped, whether the design is reasonable, and whether there are omissions. The second part of the
review is whether there is a lack of details.
The third point of review is whether the document is reasonable and whether the expression is appropriate. This is a non-technical factor, no nitpicking.