创新！ 也就是说按照标准，同时理性地执行。 不管标准是怎么规定的，包括你应该知道的内容。 这意味着用明确的语言编写，增加有意义的组织级别。 如果软件开发文档未被要求遵循...
创新！ 也就是说按照标准，同时理性地执行。 不管标准是怎么规定的，包括你应该知道的内容。 这意味着用明确的语言编写，增加有意义的组织级别。 如果软件开发文档未被要求遵循某个标准，则必须至少使用核对表来检查是否存在重大遗漏。 IEE发布的软件开发文档标准是我知道的最广泛可用的软件文档标准之一。
阅读文档遇到不明白的术语，我们会很失望。 但是，在用语集中找到说明时，沮丧的心情很快就消失了。
所有术语的定义都必须以这种方式创建：定义中使用的单词。 请尽量避免在术语表中查找意思。 一个技巧是先用日常用语说明，然后再用用语说明。 在术语说明文中，在其他地方定义的术语由楷体等特殊字体识别。 以下是示例。数据流图：为描绘系统的功能性、数据库和与系统相关联的环境之间的信息流动的图形符号。 通常用于：结构分析、转换的配置(气泡显示)、数据流(箭头显示)、数据存储(两条平行线显示)、外部实体(三角形显示)。
这个原则对所有软件开发文档（包含：网站建设，小程序开发，app开发，网站制作等）的读者来说都是不言而喻的。 令人惊讶的是，很多作者都没有注意到这一点(仔细想想，每个作者有时都是读者)。 索引通常是软件开发文档中使用的所有术语和概念的列表，其中包含一个或多个标记术语或概念的定义位置、使用位置或引用位置的页码。 这同样适用于要求、设计、编码、测试、用户和维护文档。 索引有助于读者快速找到信息，对后续文档的维护和优化也很重要。
现代文字处理软件提供了将索引引用嵌入正文的指令，从而使索引的创建变得非常简单。 文字处理软件编译索引，按字母顺序排列并输出结果。 大多数CASE工具也可以生成可用索引。
写小说时，首要目标是保持读者的兴趣； 软件技术文档要求使用相同的术语来表示相同的概念，并使用相同的语句结构来表示相似的信息。 否则，会扰乱读者，在重新考虑中需要时间确认是否有新的技术信息。 此原则必须适用于所有技术文档的创建，包括要求规范、用户手册、设计文档和代码中的注释。
有三种特殊的命令。 常规命令有四种类型。
最好写：
有三种特殊的命令。 有四种常规命令。
