软件开发的文档与审查

软件开发必须过程化,必然需要文档的辅助。需要写文档是毋庸置疑的,这包括:需求分析文档、设计文档等。但没搞过这个的项目团队,往往抓不住重点,走入一些误区。

1.没有大而全的模板

没有大而全的文档模板,能照着模板写文档。软件开发本身是一个认知和设计的过程。文档的内容就是认知和设计的结果。怎么可能在认知和设计没发生的情况下,就事先有一个模板告诉你该写什么。

模板最多提供一个固定的文档形式。但该有什么内容、如何组织这个是写文档的人的事。形式是为内容服务的。

文档模板可以起到一点提醒作用,但这也是次要的。关键在于内容。

如果能够把握住要写的内容,模板显然没有大用处。

2.评审的重点是内容

评审的第一位是内容的正确性。比如:是否把握了用户需求,设计是否合理,是否有遗漏
评审的第二位是是否缺少细节。
评审的第三位是文档行文是否合理、表达是否恰当。这是非技术因素,不必吹毛求疵。



猜你喜欢

转载自gdpglc.iteye.com/blog/2250197