项目开发文档编写规范_项目开发文档编写规范要求

开发文档怎么写？

1.1.1项目名称

项目开发文档编写规范_项目开发文档编写规范要求

项目开发文档编写规范_项目开发文档编写规范要求

项目名称（项目类型）

1.1.2项目开发者

成员一：

成员二：

成员三：

1.1.3项目开发环境

MyEclipse＋Tomcat5.5和MyEclipse（自带）＋SQL2005

1.1.4系统功能设定

品红商业网分为2大模块：

1.前台系统

##设定，商品以及购物相关功能：

NEWS：对的增加、删除和查询作，并且增加上下条功能进行查询，以及最新的显示与增加。

PRODUCT：对商品的增加、删除、修改和查询作，并且增加分页技术进行查询，以及最新商品的展示与增加；增设对商品的选购，打印清单、结算功能。

TALKING：用户之间的在线聊天，进行互动交流，洽谈业务，对信息发表自己的看法等，并设有广告介绍，让用户了解最新信息。

MESSAGE：客户留言薄，针对各种商情，业务交流进行离线留言，站外，站内用户可以通过此信息及时了解最新资讯，了解用户反馈信息等。

ABOUT：介绍了公司对客户的信心，诚意做出了诚恳的表态。

AFTER：介绍了公司关于商品的售后服务条例等，给客户提供更满意的服务。

COPYRIGHT：介绍了公司的版权信息，以及法律授权及其相关。

2.后台管理系统

##设定对，用户以及对和商品信息的相关作。

：对用户的查询和删除，对的增加，删除和查询，对商品的增加、删除、修改和查询，都增设了分页技术更有规范的查询。并附有时间，让作人员在任何时候都能得到精准时间，以提高的时间观念。

1.1.5项目开发技术

JSP+JaScript+HTML

1.1.6设计思路

通过相关技术，一一实现对，站外，站内用户，公司信息，商品信息进行实用的作。

1.1.7项目背景

本着为客户提供质的服务，项目从多角度考虑需求，以求达到客户所需要的功能，实现零距离的作。

1.1.8主要模块讲解

1.1.8.1模块一

1.名称：模块

2.：的登录，对相应信息作

实现了对用户，的作：

1.对用户的查询，删除（必要的删除），使用分页技术给更好的视觉效果。

2.添加使用了MD5加密技术，登录及相关作时的各种精密验证，达到更高的保密性，安全性。

1.1.8.2模块二

1.名称：模块

请问软件项目的技术开发文档都要写些什么呢，具体要求是什么呢，要写多少文档呢

要写的文档种类有很多；根据不同的软件系统，每种文档内容的内容、格式和要求又有所不同。

1）文档的种类可以参考任何一本《软件工程》书籍。大致包括：用户需求调研报告、需求分析、概要设计、用户手册、测试、详细设计、详细编码文档、测试报告等等

2）很多类型的软件文档都有国标(GB)或行业标准（例如军用标记——GJB)规定的格式，具体情况可查询相关标准。

软件开发文档规范

这个问题没有一定的，因为这里有多种因素如，开发阶段、文档化要求程度等，若是通过CMM评估的，文档就较多一般的是按项目开发过程来分，基本的有可行性研究报告（若是一个新项目且未确定的或应客户要求时需要，实际上大部份公司很少有这文档)用户需求说明书(用户开发人员共同确认)软件需求规格说明书设计说明书(体系结构、详细设计)测试用例用户手册实现代码这些文档中，包括一定的分析与设计图形，如用例图、数据库结构、ER图等当然项目、测试也应算在内其它的(如CMM要求的)风险、估算方面的，质量保证方面的、配置管理方面、定义的模板、度量数据库等具体需要多少文档就是要看项目实际这方面的东西，可参考一些软件工程类的书

需求文档撰写规范

在写需求文档之前我们需要弄明白需求文档是什么？他是用来做什么用的？

首先，根据根据百度百科所定义的概念，我们可以了解到产品需求文档（简称PRD）是产品项目由“概念化”阶段进入“图纸化阶段的最主要的一个文档。广义上来讲，产品需求的描述应该包含有产品的战略和战术，战略是指：产品定位、目标市场、目标用户、竞争对手等。战术是指产品的结构、核心业务流程、具体用例描述、功能、内容描述等。

PRD的主要使用对象有：开发、测试、项目、交互设计师、运用及其他业务人员

开发可以根据PRD获知整个产品的逻辑；测试可以根据PRD建用例；项目可以根据PRD拆分工作包，并分配开发人员；交互设计师可以通过PRD来设计交互细节。PRD是项目启动之前，必须要通过评审确定的最重要文档。

简单了解了需求文档是什么后，我们需要知道，写一个需求文档需要具备哪些要素，我们应该从哪些方面去写。

二、修订记录

三、产品概况

1、项目背景

2、产品定位

3、用户

四、用户角色

五、术语及解释

六、产品结构

1、产品结构图

2、信息结构图

3、业务流程图

七、产品功能

以上是撰写PRD文档的基础内容，除此之外我们还可以写一些非功能性需求，这里就不一一展开说明了。

产品需求文档是记录产品功能的重要文档，也是和开发测试沟通的重要桥梁，但是需求文档也没有完全统一的规范和样式，不同的公司会有不同的要求，因此，我们需要针对不同的产品以及场景对需求文档进行适当的删减，目的是能够表达出产品的实际需求。

[嵌入式技术] 如何规范写嵌入式系统开发文档

一个系统设计完成以后，它不应该仅仅是一些源代码，还应该包括各种各样的开发文档。这对以后自己对系统的维护和升级都有很好的参考作用。一个系统开发完成，它究竟应该包含那些文档，这些文档一般是怎么完成的，应该包含哪些内容？这就是系统开发的规范化问题。系统开发的规范化不利于自己，也有利于公司，更有利于新手。规范化的设计让工程师工作更高效，这已经是不用争论的事实。现在在大型软件工程开发方面，这已经做得相当好。但在单片机和嵌入式系统的开发方面，规范化的工作却有待我们共同探讨。在国内，一些公司的研发人员也有一种误导——快写代码，快让我看见功能，不要你做其他的，完成功能就好。这些都把我们的设计导入一种误区：大部分时间都在写代码，改代码。 嵌入式实时系统复杂度的提高，设计工程师在定义和分析系统初始要求时必须认真考虑软硬件的协同关系。通常设计工程师还必须权衡系统的灵活性、速度、成本、和可用工具之间的关系。本文打算描述嵌入式系统和实时系统的关键特性，并探讨在选择或开发硬件和软件组件的基础上开发高效嵌入式系统的解决方案，同时详细说明嵌入式系统和实时系统开发所特有的关键工艺技术。 我所知的realtime-uml的设计软件: TNI公司的ControlBuild Embedded , Rational :Rose RT iLogix :Rhapsody Artisansw :Artisan Studio Telelogic :Tau. TNI公司的ControlBuild Embedded 全流程解决方案，涵盖了整个嵌入式控制软件设计的全部过程：从用户需求、规格说明、设计、代码生成、仿真校验直到验收。 在设计的最初阶段使用可执行的（形式化的）、可视化的规格说明书和用户进行沟通，消除设计人员和用户之间的歧义。 利用仿真对设计进行校验测试，并在整个设计过程中进行递进式的校验，在设备安装之前发现可能存在的大量设计错误和问题，大大缩短现场调试的时间 支持功能性设计， 图形化IEC61131-3 语言，符合EN50128 安全标准 重复使用设计 自动生成设计文档 容易使用，快速建模 为各种软、硬件平台自动生成C 代 ROSE进行分析设计 RoseRT是Rational 在收购objecttime以后的推出的，该工具主要是基于一个叫做ROOM的模式，所有可执行<

文档编写的基本要求

1.范围

适合于Microsoft Word类文档，但编号规则适用于全部项目和模版文档。

2.文档首页(封面)

<页首>公司徽记[图标，居左上角]

文档名称[黑体，二号，加粗，居中]

文档编号[宋体，四号，居中]

版本号[宋体，四号，居中]

<页尾> 作者：[宋体，四号，居中]

年 月 日[宋体，四号，居中]

公司名称[宋体，四号，居中]

命名规则：当前版本没有设置专门的规则，只是用中文命名，这个文件名表达了编写该文档的意图，后缀为相应文档编辑软件的扩展名。

编号规则：Q/RKS ---

公司代码

< ID > 英文缩写

1）SP 软件过程模板类

2）YYXXX 项目工作产品类

YYXXX表示项目代码，五位：YY：为年号 XXX：为序号

文档类别，英文缩写。

例子： GNR 通用类文档

RM 需求类文档（包括验收）

SPP 项目类文档（包括各种测试）

SPT 跟踪和类文档

SQA 质量保证类文档

SCM 配置管理类文档

PR 评审类文档

COM 沟通类文档

DES 设计类文档

TRN 培训类文档

EST 项目估算类文档

TEC 技术标准类文档

DEV 开发规范类文档

MTN 维护类文档

DB 数据库DDL脚本类文档

QC 测试类文档

文件按时间产生的顺序号，范围01-99。

例子： Q/RKS-SP-GNR -09 -> 文档书写规范

版本编号：初始的版本号为1.0，为适应某一方面的要求进行的升级为点版本升级，如1.1、1.2等，全面的设计更改或大的变更，升级为2.0、3.0等。

说明：在项目中使用各种模版时，模版中出现的软件过程模版类编号一律改为项目工作产品类编号，如软件需求说明书页脚的Q/RKS-SP-RM-05改为Q/RKS-YYXXX-RM-SNO。

3.页眉与页脚

(1)、原则：页面属性[版式]配置为首页不同，即首页之后的页面均采用本节规定的格式，[文档网格]配置为无网格。

(2)、页眉： 文档名称 [宋体，五，左齐] 版本号：[宋体，五，居中] 公司徽记[图标，右齐]

自动加下划线

例子：

软件需求说明书 版本号：1.0

(3)、页脚：

文档ID[宋体，小五，左齐]年 月 日[宋体，小五，居中]Page of [宋体，小五，右齐]

例子：

Q/RKS-SP-RM-05 2001年8月15号 Page 1 of 5

说明：在项目使用时，其中版本号为项目文档的版本号，日期为项目文档的编写时间。

4.文档控制和签字确认

有首页(封面)的放在第二页，即目录页前一页；无封面放在一节。

例子：

文档修订

版本 日期 修改人 描述（注明修改的条款或页）

批准人签字

职务 甲方/乙方 姓名 日期

5.目录

比较大的文档可设置目录页，配置为显示页码和页码右对齐，直接插入即可，单独成为一页。此页加正文“目录” [黑体，二号，加粗，居中]。显示级别为3，格式选模板中“正式”，字体四号。

6.正文（含附录）

字体：中文宋体小四，不加粗；

标题1：黑体，三号，加粗(Microsoft word2000缺省)；如:“1.”

标题2：黑体，四号，加粗(Microsoft word2000缺省); 如:“1.1”

标题3：黑体，小四号，加粗(Microsoft word2000缺省), 如:“1.1.1”

编号控制在4级之内。

行间距：单倍行间距。

段落出现两行以上的首行缩进二个汉字，段落间可加一空行。

Android APP开发需求文档范本是什么样的？

软件需求文档格式的标准写法x0dx0a1．引言x0dx0a x0dx0a1．1 编写目的x0dx0a x0dx0a· 阐明开发本软件的目的；x0dx0a x0dx0a1．2 项目背景x0dx0a x0dx0a· 标识待开发软件产品的名称、代码；x0dx0a x0dx0a· 列出本项目的任务提出者、项目负责人、系统分析员、系统设计员、程序设计员、程序员、资料员以及与本项目开展工作直接有关的人员和用户；x0dx0a x0dx0a· 说明该软件产品与其他有关软件产品的相互关系。x0dx0a x0dx0a1．3 术语说明x0dx0a x0dx0a列出本文档中所用到的专门术语的定义和英文缩写词的原文。x0dx0a x0dx0a1．4 参考资料（可有可无）x0dx0a x0dx0a 列举编写软件需求规格说明时所参考的资料，包括项目经核准的任务书、合x0dx0a x0dx0a同、引用的标准和规范、项目开发、需求规格说明、使用实例文档，以及相关产品x0dx0a x0dx0a的软件需求规格说明。x0dx0a x0dx0a 在这里应该给出详细的信息，包括标题、作者、版本号、发表日期、出版单位或资x0dx0a x0dx0a料来源。x0dx0a x0dx0a2．项目概述x0dx0a x0dx0a 2．1 待开发软件的一般描述x0dx0a x0dx0a 描述待开发软件的背景，所应达到的目标，以及市场前景等。x0dx0a x0dx0a 2．2 待开发软件的功能x0dx0a x0dx0a 简述待开发软件所具有的主要功能。为了帮助每个读者易于理解，可以使用列表或x0dx0a x0dx0a图形的方法进行描述。使用图形表示，可以采用：x0dx0a x0dx0a · 顶层数据流图；x0dx0a x0dx0a · 用例UseCase图；x0dx0a x0dx0a · 系统流程图；x0dx0a x0dx0a · 层次方框图。x0dx0a x0dx0a 2．3 用户特征和水平（是哪类人使用）x0dx0a x0dx0a 描述最终用户应具有的受教育水平、工作经验及技术专长。x0dx0a x0dx0a 2．4 运行环境x0dx0a x0dx0a 描述软件的运行环境，包括硬件平台、硬件要求、作系统和版本，以及其他的软x0dx0a x0dx0a件或与其共存的应用程序等。x0dx0a x0dx0a 2．5 条件与限制x0dx0a x0dx0a 给出影响开发人员在设计软件时的约束条款，例如：x0dx0a x0dx0a · 必须使用或避免使用的特定技术、工具、编程语言和数据库；x0dx0a x0dx0a · 硬件限制；x0dx0a x0dx0a · 所要求的开发规范或标准。x0dx0a x0dx0a3．功能需求x0dx0a x0dx0a 3．1 功能划分x0dx0a x0dx0a 列举出所开发的软件能实现的全部功能，可采用文字、图表或数学公式等多种方法x0dx0a x0dx0a进行描述。x0dx0a x0dx0a3．2 功能描述x0dx0a x0dx0a对各个功能进行详细的描述。x0dx0a x0dx0a4．外部接口需求x0dx0a x0dx0a4．1 用户界面x0dx0a x0dx0a对用户希望该软件所具有的界面特征进行描述。以下是可能要包括的一些特征：x0dx0a x0dx0a· 将要采用的图形用户界面标准或产品系列的风格；x0dx0a x0dx0a· 屏幕布局；x0dx0a x0dx0a· 菜单布局；x0dx0a x0dx0a· 输入输出格式；x0dx0a x0dx0a· 错误信息显示格式；x0dx0a x0dx0a建议采用RAD开发工具， 比如Visio，构造用户界面。x0dx0a x0dx0a4．2 硬件接口x0dx0a x0dx0a 描述系统中软件产品和硬件设备每一接口的特征，以及硬件接口支持的设备、软件与硬件接口之间，以及硬件接口与支持设备之间的约定，包括交流的数据和控制信息的性质以及所使用的通信协议。x0dx0a x0dx0a4．3 软件接口x0dx0a x0dx0a 描述该软件产品与其有关软件的接口关系，并指出这些外部软件或组件的名字和版本号。比如运行在什么作系统上，访问何种类型的数据库，使用什么数据库连接组件，和什么商业软件共享数据等。x0dx0a x0dx0a4．4 通信接口x0dx0a x0dx0a 描述和本软件产品相关的各种通信需求，包括电子邮件、Web浏览器、网络通信协议等。x0dx0a x0dx0a4．5 故障处理x0dx0a x0dx0a 对可能的软件、硬件故障以及对各项性能而言所产生的后果进行处理。x0dx0a x0dx0a5．性能需求x0dx0a x0dx0a5．1 数据度x0dx0a x0dx0a输出结果的精度。x0dx0a x0dx0a 5．2 时间特性x0dx0a x0dx0a 时间特性可包括如下几方面x0dx0a x0dx0a ·响应时间；x0dx0a x0dx0a ·更新处理时间；x0dx0a x0dx0a ·数据转换与传输时间；x0dx0a x0dx0a ·运行时间等。x0dx0a x0dx0a 5．3 适应性x0dx0a x0dx0a 在作方式、运行环境、与其他软件的接口以及开发等发生变化时，软件的适应能力。x0dx0a x0dx0a6．其他需求x0dx0a x0dx0a列出在本文的其他部分未出现的需求。如果不需要增加其他需求，可省略这一部分。x0dx0a x0dx0a7．数据描述x0dx0a x0dx0a 7．1 静态数据x0dx0a x0dx0a 7．2 动态数据x0dx0a x0dx0a包括输入数据和输出数据。x0dx0a x0dx0a 7．3 数据库描述x0dx0a x0dx0a 给出使用数据库的名称和类型。x0dx0a x0dx0a 7．4 数据字典x0dx0a x0dx0a对于数据流图、层次方框图中出现的所有图形元素在数据字典中都要作为一个词条加以定义，使得每一个图形元素都有的一个清晰明确的解释。x0dx0a x0dx0a数据字典中所有的定义必须是严密的、的，不可有二意性。x0dx0a x0dx0a 7．5 数据采集x0dx0a x0dx0a ·列出提供输入数据的机构、设备和人员x0dx0a x0dx0a ·列出数据输入的手段、介质和设备；x0dx0a x0dx0a ·列出数据生成的方法、介质和设备。x0dx0a x0dx0a8．附录x0dx0a x0dx0a 包括分析模型，待定问题图表等。

项目文档方面编写心得（高分）

编写要注意语句通顺，内容大气，考虑周全，熟悉对各种文档的灵活运用。整理要分类整理，详细备案，在别人说出某一个文档之后你能迅速找到，尽量是自己的工作效率化

CMMI接触过，还有CMM3啊