`
gdpglc
  • 浏览: 92208 次
  • 性别: Icon_minigender_1
  • 来自: 长春
社区版块
存档分类
最新评论

软件开发的文档与审查

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

1.没有大而全的模板

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

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

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

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

2.评审的重点是内容

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



1
1
分享到:
评论

相关推荐

    软件开发相关文档软件开发文档软件开发文档软件开发文档

    本文将深入探讨软件开发文档的重要性、种类、结构以及如何编写有效的软件开发文档。 首先,软件开发文档是整个开发流程的灵魂,它记录了项目的每一个阶段,包括需求分析、设计、编码、测试和维护等。文档的清晰度和...

    软件开发文档模板

    以下是对"软件开发文档模板"的详细解析: 1. **需求规格说明书**:这份文档详细阐述了软件的需求,包括功能性和非功能性需求。它帮助开发者明确系统的目标,确保所有参与者对项目有统一的理解。内容通常涵盖用户...

    软件开发文档编写标准规范

    《软件开发文档编写标准规范》是一份至关重要的参考资料,它为软件开发团队提供了一套详细的指导原则和格式,确保在项目开发过程中产生的各种文档能够清晰、一致且有效地传达信息。文档是软件工程的重要组成部分,它...

    GJB 438B军用软件开发文档通用要求

    《GJB 438B军用软件开发文档通用要求》是针对军事领域软件开发的一套规范性标准,旨在确保软件开发的质量、安全性和可靠性。这份文档详细规定了从项目启动到软件交付整个生命周期中所需的各类文档及其内容,涵盖了...

    软件开发文档编写

    下面将详细讲解软件开发文档的编写及其重要性。 一、开发文档概述 开发文档是记录软件开发过程、设计思路、实现方法以及测试结果等信息的书面材料。它包括但不限于需求规格说明书、设计文档、用户手册、测试计划和...

    软件开发必备文档(包含软件开发所需各种文档需求)

    在软件开发过程中,文档起着至关...对于初学者来说,理解和掌握这些文档的编写与使用,将有助于提升其在软件开发领域的专业素养。而对于经验丰富的开发者,一套完整、详尽的文档体系更是保证项目稳定、高效进行的基石。

    软件开发文档模板(全套).zip

    "软件开发文档模板(全套).zip" 提供了一系列的标准模板,涵盖了软件工程中的多个重要阶段。以下将详细阐述每个文档模板的重要性和内容: 1. **一、可行性研究报告.dot**:在项目启动初期,这个文档用于评估项目的...

    CMMI软件开发文档

    **CMMI(Capability Maturity Model Integration)软件开发文档** CMMI,即能力成熟度模型集成,是一种评估和改进组织在项目管理、系统工程、软件工程、硬件工程和服务提供等领域绩效的方法。CMMI提供了从初始级到...

    GJB438B-2009军用软件开发文档通用要求

    ### GJB438B-2009军用软件开发文档通用要求解析 #### 一、概述 《GJB438B-2009军用软件开发文档通用要求》是一项重要的军用标准,它规定了在军用软件开发过程中所需的各种文档的要求和规范。该标准旨在提高军用...

    软件开发文档范例

    标题 "软件开发文档范例" 暗示了我们即将探讨的是软件开发过程中不可或缺的文档规范,这些文档有助于团队协作,确保项目的顺利进行,并且在软件的整个生命周期中起到指导和记录作用。软件开发文档是专业开发过程中的...

    软件开发全部文档

    对于软件开发团队而言,这些文档是确保项目成功的关键工具,也是与客户、管理者和其他利益相关者沟通的有效媒介。通过详尽的文档,团队可以更好地协同工作,提高效率,降低风险,最终打造出高质量的软件产品。

    软件开发文档模板,标准专辑

    这个“软件开发文档模板,标准专辑”包含了74册文档模板,总计7.9M的大小,旨在为软件开发人员提供一套完整的、标准化的文档指南。 1. **需求分析文档**:这是软件开发的第一步,包括需求规格说明书,功能需求描述,...

    国家标准软件开发文档模板

    国家标准软件开发文档模板是指导软件开发过程中的一个重要工具,它为项目团队提供了统一的格式和内容规范,确保了文档的质量和一致性。这份模板遵循了GB856T——88的标准,该标准是中国关于软件工程文档编制的一个...

    软件开发文档大全

    "软件开发文档大全"集合了各种在软件开发生命周期中必不可少的文档模板,涵盖了从需求分析到系统维护的全过程。下面将详细阐述这些文档的主要内容及其重要性。 1. **需求规格说明书**:这是项目开始时的关键文档,...

    软件开发文档规范

    本文将详细探讨“软件开发文档规范”中涉及的各项内容,旨在帮助开发者理解并遵循这些标准,以确保项目的顺利进行。 1. 需求分析文档:这是项目启动阶段的关键文档,用于明确软件应实现的功能以及满足用户需求的...

    软件开发-软件技术文档

    在软件开发过程中,技术文档扮演着至关重要的角色。它们不仅是团队间沟通的桥梁,也是确保项目按计划进行、保持质量标准的关键工具。本压缩包“软件开发-软件技术文档”包含了软件开发全生命周期中涉及的各种文档...

    软件开发文档编写规范

    本文将深入探讨“软件开发文档编写规范”,包括开发计划书和软件开发规范这两个关键部分。 首先,我们要了解开发计划书的编写。开发计划书是项目启动阶段的必备文档,它为整个开发过程提供了蓝图。一个完整的开发...

    GJB 438B-2009 军用软件开发文档通用要求

    《GJB 438B-2009 军用软件开发文档通用要求》是中国军事标准中关于软件开发文档规范的重要文件,旨在确保军用软件的质量、安全性和可靠性。这份标准详细规定了在军用软件开发过程中所需的各种文档内容、格式以及编制...

    软件开发——国家标准文档

    在软件开发过程中,国家标准文档是指导项目顺利进行的重要依据,它们确保了开发团队遵循一致的规范,提高了软件质量,降低了沟通成本。以下是一些关键的软件工程国家标准文档及其详细内容: 1. **需求规格说明书**...

    软件开发文档常用模板.rar

    "软件开发文档常用模板.rar" 是一个包含多种关键文档模板的压缩包,这些模板适用于软件工程和软件开发的各个环节。以下是这些模板的主要内容及其重要性: 1. **开发任务书**:开发任务书是项目启动阶段的重要文档,...

Global site tag (gtag.js) - Google Analytics