软件开发的文档与审查
程序员文章站
2022-05-20 16:40:27
...
软件开发必须过程化,必然需要文档的辅助。需要写文档是毋庸置疑的,这包括:需求分析文档、设计文档等。但没搞过这个的项目团队,往往抓不住重点,走入一些误区。
1.没有大而全的模板
没有大而全的文档模板,能照着模板写文档。软件开发本身是一个认知和设计的过程。文档的内容就是认知和设计的结果。怎么可能在认知和设计没发生的情况下,就事先有一个模板告诉你该写什么。
模板最多提供一个固定的文档形式。但该有什么内容、如何组织这个是写文档的人的事。形式是为内容服务的。
文档模板可以起到一点提醒作用,但这也是次要的。关键在于内容。
如果能够把握住要写的内容,模板显然没有大用处。
2.评审的重点是内容
评审的第一位是内容的正确性。比如:是否把握了用户需求,设计是否合理,是否有遗漏
评审的第二位是是否缺少细节。
评审的第三位是文档行文是否合理、表达是否恰当。这是非技术因素,不必吹毛求疵。
1.没有大而全的模板
没有大而全的文档模板,能照着模板写文档。软件开发本身是一个认知和设计的过程。文档的内容就是认知和设计的结果。怎么可能在认知和设计没发生的情况下,就事先有一个模板告诉你该写什么。
模板最多提供一个固定的文档形式。但该有什么内容、如何组织这个是写文档的人的事。形式是为内容服务的。
文档模板可以起到一点提醒作用,但这也是次要的。关键在于内容。
如果能够把握住要写的内容,模板显然没有大用处。
2.评审的重点是内容
评审的第一位是内容的正确性。比如:是否把握了用户需求,设计是否合理,是否有遗漏
评审的第二位是是否缺少细节。
评审的第三位是文档行文是否合理、表达是否恰当。这是非技术因素,不必吹毛求疵。
上一篇: 一起的都是垃圾
下一篇: 集体来搞笑,群体的力量就是大。
推荐阅读
-
Word利用书签与超链接实现文档中段落之间的交互跳转
-
java使用dom4j生成与解析xml文档的方法示例
-
php导出word文档与excel电子表格的简单示例代码
-
ASP.NET Core 2.0集成Office Online Server(OWAS)实现办公文档的在线预览与编辑(支持word\excel\ppt\pdf等格式)
-
Word2007文档修订内容的打开与关闭方法
-
使用Python通过win32 COM实现Word文档的写入与保存方法
-
关于JS与jQuery中的文档加载问题
-
程序员薪资与发展(四):软件开发者的职业发展之路
-
基于PHP与XML的PDF文档生成技术
-
公司加密系统之源代码加密防拷贝方案、文档透明加密与环境加密的区别