最近接手公司的一个需要项目,我最主要的工作便是编写整理项目文档。以前除了上大学交论文的时候写过什么概要设计、详细设计,工作以来还没写过这些东西。
请教项目经理、上网查资料发现这些文档还真没有统一的格式,千奇百怪,这就愁坏了我这样的新手,虽说有GB T-8567-2006标准,但是这也不是模板,故在自己不断总结摸索中,总结出了一些文档格式,希望对大家有所帮助。


先来说说一个项目的文档都包括什么:

  • 需求规格说明书

    需求规格说明书是对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议,也是实施开发工作的基础。
    有的为了更严谨还会有需求调研报告等文档,咱们这里讨论主要也是必须的文档。

  • 项目开发计划

    项目开发计划为软件项目实施方案制定出具体计划,应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。项目开发计划应提供给管理部门,并作为开发阶段评审的参考。

  • 建设方案

    该文档根据需求分析说明书,对系统建设整理出总体流程及系统总体编码规范等,为设计人员、编程人员及测试人员工作的基础。

  • 概要设计说明书

    该说明书是概要设计阶段的工作成果,它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等,为详细设计奠定基础。

  • 详细设计说明书

    编制目的是说明一个软件系统各个层次中的每一个程序 (每个模块或子程序)的设计考虑,着重描述每一模块是怎样实现的,包括实现算法、逻辑流程等。

  • 测试计划

    为做好组装测试和确认测试,需为如何组织测试制定实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

  • 测试用例

    项目测试用例设计,是为项目编制的测试输入、执行条件以及预期结果,以便测试某个程序路径或核实是否满足需求。

  • 测试报告

    测试工作完成以后,应提交测试计划执行情况的说明。对测试结果加以分析,并提出测试的结论意见。

  • 用户操作手册

    该手册详细描述软件的功能、性能和用户界面,使用户了解如何使用该软件。

  • 系统安装部署手册

    顾名思义,就是项目软件及软件环境、数据库等相关软件的安装及部署手册,详细描述安装步骤。

  • 培训方案

    培训方案是从组织的战略出发,在全面、客观的培训需求分析基础上做出的对培训内容、培训时间、培训地点、培训者、培训对象、培训方式和培训费用等的预先系统设定。


说完了文档包括哪些,下面来说说文档书写模板。

需求规格说明书

1引言
1.1编写目的
1.2适用范围
1.3术语和缩写
1.4参考资料
2项目概述
2.1项目背景
2.2建设目标
2.3项目遵循的标准或规范
2.4用户特征
3系统功能需求
3.1系统总体功能
3.2组织结构图
3.3系统角色
3.4主要功能流程图
3.5系统功能详情
4外部接口需求
4.1用户接口
4.2硬件接口
4.3软件接口
4.4通信接口
5系统数据需求
5.1数据内容
5.2数据的逻辑描述
5.2.1静态数据
5.2.2动态输入数据
5.2.3动态输出数据
5.2.4内部生成数据
5.2.5数据约定
5.3数据的采集
5.3.1要求和范围
5.3.2输入的承担者
5.3.3预处理
5.3.4影响
6系统非功能需求
6.1用户界面需求
6.2软件环境需求
6.3硬件环境需求
6.4网络需求
6.5安全设施需求
6.6产品质量需求
6.7故障处理需求


项目开发计划

1引言
1.1编写目的
1.2项目背景
1.3术语与缩略语
1.4参考资料
1.5标准、条件和约定
2项目概述
2.1工作内容
2.2主要参加人员
2.3产品及成果
2.3.1程序
2.3.2文件
2.3.3服务
2.3.4非移交产品
2.4验收标准
2.4.1代码的验收
2.4.2文档验收
2.4.3服务验收
2.5完成项目最迟期限
3实施总计划
3.1开发过程
3.1.1需求分析
3.1.2系统设计
3.1.3编码及测试阶段
3.1.4文档、产品部署
3.1.5项目总结
3.2工作任务分解
3.3接口人员
3.4进度
3.5关键问题
4支持条件
4.1计算机系统支持
4.2需要用户承担的工作
4.3需由外单位提供的条件
5专题计划要点
5.1培训计划
5.2测试计划
5.3质量保证计划
5.4安全保密计划
5.5合同计划

注:其中内容可根据具体情况酌情删减。
为避免篇幅过长,其他文件模板将在下一篇说明。

项目验收文档模板(一)相关推荐

  1. 项目验收文档合并技巧

    1)先将各个文件word写好,格式,字体调整好: 2)每个word导出PDF: 3)将导出的PDF合并到一个大的PDF:

  2. 【项目需求说明书文档模板】WEB即时通讯规格说明书

    说明书 WEB即时通讯规格说明书 说明+需求+规格 详细模板联系我邮箱:lcyangmi@163.com 保密声明 本方案的内容属于个人.公司(XXXX)的知识财产,属于机密文档,将被限制做进一步的传 ...

  3. mfc 制作不同的文档模板mdi不同的子窗体_对IT项目售前解决方案制作的一些思考...

    作者:人月神话,新浪博客同名 简介:多年SOA规划建设,私有云PaaS平台架构设计经验,长期从事一线项目实践 今天准备对于IT项目售前解决方案的制作,对于一个软件企业来说,往往会针对自己的产品线和产品 ...

  4. 《信息化项目文档模板十一——系统运维流程工作流程模板》

    系列文章目录 <信息化项目文档模板一--项目需求说明书> <信息化项目文档模板二--项目启动会文档模板> <信息化项目文档模板三--会议纪要模板> <信息化项 ...

  5. 《信息化项目文档模板四——系统建设方案模板》

    系列文章目录 <信息化项目文档模板一--项目需求说明书> <信息化项目文档模板二--项目启动会文档模板> <信息化项目文档模板三--会议纪要模板> <信息化项 ...

  6. 《信息化项目文档模板二——项目启动会文档模板》

    系列文章目录 <信息化项目文档模板一--项目需求说明书> <信息化项目文档模板二--项目启动会文档模板> <信息化项目文档模板三--会议纪要模板> <信息化项 ...

  7. 《信息化项目文档模板十三——研发项目申报书 》

    系列文章目录 <信息化项目文档模板一--项目需求说明书> <信息化项目文档模板二--项目启动会文档模板> <信息化项目文档模板三--会议纪要模板> <信息化项 ...

  8. 项目计划书、规划文档模板

    项目计划书.规划文档模板 最近通过项目实践经历,整理出的一套项目计划书(仅供自己参考梳理思路使用)有喜欢的文末加VX 辛苦码字如有转载请标明出处谢谢!--木研 更新的简版项目规划文档! 原版文件请+v ...

  9. 《信息化项目文档模板三——会议纪要模板》

    系列文章目录 <信息化项目文档模板一--项目需求说明书> <信息化项目文档模板二--项目启动会文档模板> <信息化项目文档模板三--会议纪要模板> <信息化项 ...

  10. 《信息化项目文档模板五——系统详细设计模板》

    系列文章目录 <信息化项目文档模板一--项目需求说明书> <信息化项目文档模板二--项目启动会文档模板> <信息化项目文档模板三--会议纪要模板> <信息化项 ...

最新文章

  1. (LeetCode 21)Merge Two Sorted Lists
  2. UIActivityViewController: LaunchServices: invalidationHandler called
  3. 5334. 【NOIP2017提高A组模拟8.24】空
  4. how is sales pipeline retrieved from backend
  5. Python爬虫有什么用,网友纷纷给出自己的答案,爬虫能做的还是很多的
  6. Java抓取Codeforces——针对某一次提交的源码和数据
  7. BZOJ 2287 POJ Challenge 消失之物
  8. 剑指 Offer II 110. 所有路径
  9. mysql找不到服务_win7系统安装mysql后找不到服务或提示找不到指定文件如何解决...
  10. Kotlin基本类型
  11. html5字幕提取软件,VideoSubFinder(提取视频字幕软件)
  12. cad重新加载php命令,cad撤回命令是什么
  13. 【机器学习笔记】【随机森林】【回归器】【填充缺失值】
  14. 图像处理: 可见光波长(wavelength)与RGB之间的转换
  15. QThread 结束后,不发射Finished问题
  16. could和may区别请求_can和may的区别及用法
  17. python编程要懂英语吗_学习编程必须要会英语吗?
  18. 2022国赛中职网搭 windows组策略
  19. Android之sd卡,SharedPreferences,xml
  20. 雷卯推荐TVS低漏流100uA,低电压3.3v,功率400W

热门文章

  1. jQuery框架的ajax
  2. 主流Ajax框架介绍
  3. 2万字用Python探索金庸小说世界
  4. Veritas Backup Exec 21.3 Multilingual (Windows)
  5. spring-boot设置静态文件路径
  6. quartz mysql 配置_quartz的数据库配置
  7. 诚意满满的奉上2000套Axure原型图设计源文件UI UX交互设计案例
  8. 华成英-模拟电子技术P11 场效应管及其放大电路 笔记
  9. mhd matlab,应用 | 基于磁流体MHD的FLUENT-Maxwell集成耦合开发
  10. RX.AutoImage+Fluent Airpak v2.1