PB's Document Standard

Author: Xingda Computer technology company (www.study01job.com) Guo Baoli

The documentation described here includes not only the design documentation for the application system, but also the relevant notes for the source program. A fully documented application system facilitates system maintenance, upgrades, and easy communication with other developers.

I. Notes

• Developers must provide comments on all the content they produce. Includes tables, columns in tables, objects, controls, and script.

L table and column annotations that add comments to tables and columns in table and database painter.

L object annotation that can be added to the object's painter, which can be seen in the library painter.

For script, add complete comments to all event handlers and functions. First, add a comment at the beginning of each script, explain the function of this script segment, its salient features, the time and requirements for writing and modifying (such as entry and exit parameters, etc.), and then further reveal the role of each piece of code throughout each segment of the program.

Each function needs to have a certain format of the function description, parameter description, if there is a modification, should indicate the modified content, when the program is formally delivered, the annotation should not be removed from the program code.

Second, online Help

Online Help provides help documents in the current, more popular format, and content is aligned with the final release software. Help documents are easy to use, can be easily jumped, and can be easily searched by topic. For software that is slightly more complex, it is recommended that you provide a help document with the following general framework:

1. To provide the latest additions to the new version of the features and changes;

2. Provide introductory help such as get start so that users can easily get started;

3. Provide detailed instructions for use;

Provide typical problems and solutions, and provide technical support telephone.