写出好文档的7个原则。感觉对写论文也很有参考价值,因而贴出来。文章内容摘自"Documenting Software Architectures: Views and Beyond"。先写下来,以后慢慢添加自己的理解。
1.Write Documentation from the Reader’s Point of View
站在用户的角度写文档
2.Avoid Unnecessary Repetition
避免不必要的重复
3.Avoid Ambiguity
避免二义性
4.Use a Standard Organization
使用标准化组织结构
5.Record Rationale
记录某个决定的时候,应该同时记录拒绝其他选择的理由
6.Keep Documentation Current, But Not Too Current
时常更新文档,但不要更新的太频繁
7.Review Documentation for Fitness of Purpose
经常改进文档使之更加实用
没有评论:
发表评论