Software Engineering notes-Other side

What kind of documents are needed?

1.Purpose. Main features and development reasons.

2.Environment.

3.Range. What is the input valid range?

4.Functions and usageAlgorithm.

5.Input and Output formats.

6.Operation Command.

7.Option

8.Running time

9.Precision and Verification

Flowchart

The flowchart should not be too arrogant. It is just a means to reflect the logical structure of the software and try to draw it on a single page. The detailed flowchart recorded one by one is outdated and annoying. It is only suitable for the algorithm thinking of beginners.

Self-documentedProgram

The solution of the document is to "Merge files", that is, to integrate the document into the source program. This is a direct and powerful promotion for proper maintenance, ensuring that programming users can obtain documents in a convenient and timely manner. This type of program is called self-documenting.

It seems that it is clumsy to include flowcharts in the document. Considering the backwardness of flowcharts and the dominance of advanced languages, it is reasonable to put programs and documents together.