编写软件文档时，应当遵循以下原则和技巧，以确保文档结构清晰、易于理解，并满足不同类型读者的需求：
内容组织
每段内容应有合适的位置，并置于合适的位置。
为每类文档制定模板，开发人员按照模板编写，例如遵循GJB438B/C的要求。
避免重复
对于重复信息，可以使用引用或强化，即在文档的不同部分多次出现相同的内容，以加深读者的理解。
定义术语
尽量使用标准中定义的术语，并对关键且易有歧义的术语进行专门定义。避免使用不必要的冗余术语和复杂的表达方式。
简洁性
使用简单语句，避免复杂的长句和过多的形容词及副词。多使用图表来辅助说明。
精确性
力求文档内容精确，避免模糊和歧义的词汇。
文档结构
通常包括封面、修改历史、文档摘要、目录、正文、总结、附件、页眉和页脚等部分。
正文部分应包括项目背景、项目简介、专业术语定义、主要描述的内容等，并按照总分总的形式完成。
针对受众
根据文档的不同受众（如最终用户、开发伙伴、测试团队等）调整内容的繁简程度和深度。重点放在用户最需要的部分，例如用户界面和使用手册。
实用性
文档内容应具有实用价值，避免无意义的干扰文本，确保读者能够快速有效地获取所需信息。
引用和署名
对于引用的内容，应使用双引号标注并注明出处。对于自己创造的内容，应写上自己的名字。
符合标准
可以参考相关的国家和国际标准，例如《软件设计文档国家标准》，以确保文档的规范性和一致性。
通过遵循这些原则和技巧，可以编写出高质量的软件文档，有效传达信息，提高软件开发的效率和质量，同时便于后续的维护和使用。