其他程序员的文档

记录程序不是您在项目结束时执行的操作; 如果您在构造和编码程序时记录有关该程序的信息，那么您的文档将更加完整，并且对其他人更有用。 包含可能对必须使用您的程序的其他人有用的任何信息。

记录此信息的原因是为了使维护程序的人员知道为什么选择某些命令，选项，调用结构和命令代码。 例如，如果 DBA 正在考虑以某种方式重组数据库，那么有关程序按数据访问方式访问数据的原因的信息将很有用。

您可以为其他程序员提供的信息包括:

• 程序的流程图和伪代码
• 有关来自代码检查的程序的注释
• 程序流的书面描述
• 有关选择调用序列的原因的信息，例如:
  • 是否使用 DFSDDLT0测试了调用序列?
  • 在多个调用组合将具有相同结果的情况下，您为何选择所执行的序列?
  • 另一个序列是什么? 是否使用 DFSDDLT0对其进行了测试?
• 在构造或编码程序时迂到的任何问题
• 测试程序时迂到的任何问题
• 关于不应在程序中更改的内容的警告

所有这些信息都与构造和编码程序相关。 此外，您应该将针对最终用户的文档与针对程序员的文档一起包含。

最终，您必须确定记录程序所需的详细信息级别和最适合的形式。 这些文档准则作为建议提供。