你会写开发文档吗

2023-05-16

你会写软件开发文档吗?


如今,软件开发越来越复杂,软件的功能也越来越丰富。而几乎所有成熟的商业软件,都是一个开发团队齐心协力的血汗结晶。“罗马不是一天建成的。”,当我们震撼于Microsoft Windows的惊世巨著的同时,也道听途说了一些微软公司软件工程是如何的完善和规范。软件项目管理的成败是控制开发成本的关键环节。这里面,少不了贯穿其中的重要步骤——软件文档。

软件文档可以分为开发文档和产品文档两大类:

开发文档包括:《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。

产品文档包括:《产品简介》、《产品技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、 《用户报告》、《销售培训》等。

一、开发文档

1. 《功能要求》——来源于客户要求和市场调查,是软件开发中最早期的一个环节。客户提出一个模糊的功能概念,或者要求解决一个实际问题,又或者是参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书,把他们的要求全部列表书写在文档中,必要时加以图表解说。这份文档是需求分析的基础。

2. 《投标方案》——根据用户的功能要求,经过与招标方沟通和确认,技术人员开始书写《投标方案》,方案书一般包括前言、需求分析、技术方案、项目管理、技术支持、系统报价、项目进度等。

3. 《需求分析》——包括产品概述、主要概念、操作流程、功能列表、注意事项、系统环境等。以《功能要求》为基础,进行详细的功能分析,列出本产品是什么,有什么特殊的概念,包括那些功能分类,需要具备什么功能,该功能的操作如何,实现的时候该注意什么细 节,客户有什么要求,系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。

4. 《技术分析》——包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价,竞争对手技术分析等。以《需求分析》为基础,进行详细的技术分析(产品的性能和实现方法),列出本项目需要使用什么技术方案,为什么,有哪些技术问题要解决 ,估计开发期间会碰到什么困难,技术方案以后如何升级,对本项目的技术有什么评价等。

5. 《系统分析》——包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以《需求分析》为基础,进行详细的系统分析(产品的开发和实现方法),程序员根据《系统分析》,开始在项目主管的带领下进行编码工作。

6. 《数据库文档》——包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以《系统分析》为基础,进行详细的数据库设计,必要时可以用图表解说,特别是关系数据库。

7. 《功能函数文档》——包括变量名、变量初植、功能、函数名、参数、如何调用、备注、注意事项等。以《系统分析》为基础,进行详细的说明,列出哪个功能涉及多少个函数,以便以后程序员修改、接手和扩展。

8. 《界面文档》——包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求,这里与软件完成后的运行界面是一致的。

9. 《编译手册》——包括服务器编译环境、操作系统、编译工具、编译器版本信息、目录说明、程序生成、源程序文件列表、Makefile配置及其相关程序的对应关系列表。客户端的编译过程、编译结果、编译示例、编译环境、操作系统、编译工具、源文件列表和制作安装程序的过程。

10. 《QA文档》——包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要求等,提供给软件测试人员使用。

11. 《项目总结》——包括项目简介、项目参与人员和开发时间、项目风险、管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员工作情况等。

二、产品文档

1. 《产品简介》——包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公司联系地址等。

2. 《产品演示》——包括公司简介、产品背景、产品描述、产品特点、产品作用、适用范围、使用分析、功能模块、解决问题、合作伙伴、成功案例等。一般用Powerpoint或者视频录制软件实现。

3. 《疑问解答》——列出用户关心的问题和处理方法,用于解答软件的操作功能和解决用户的疑难问题。

4. 《功能介绍》——以《需求分析》为书写基础,包括软件介绍、软件结构、功能列表、功能描述等。

5. 《技术白皮书》——以《技术分析》为书写基础,包括功能实现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向等。

6. 《评测报告》——第三方的权威评测报告。包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。

7. 《安装手册》——包括系统环境、运行平台、产品安装过程、初始环境设置、安装记录等。

8. 《使用手册》——包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等。

9. 《维护手册》——包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份、技术问题解答和联系方式等。

10. 《用户报告》——包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等。

11.《销售培训》——包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、目标客户等。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

你会写开发文档吗 的相关文章

随机推荐

  • 常用编码方式说明

    各种语言需要交流 xff0c 经过翻译是必要的 xff0c 那又如何来翻译呢 xff1f 在计算机中提供了多种翻译方式 xff0c 常见的有 ASCII ISO 88591 GB23112 GBK UTF 8 UTF 8 UTF 16等 它
  • 报文头格式以及常用协议端口

    IP协议是TCP IP协议族的动力 xff0c 它为上层协议提供无状态 无连接 不可靠的服务 优点 xff1a 简单 xff0c 高效 无状态指 xff1a IP通信双方不同步传输数据的状态信息 xff0c 所有的IP数据报的传输都是独立的
  • iOS中NSThread子线程需要建立NSAutoreleasePool

    今天做iOS开发时碰到一个问题 xff1a 在主线程打开一个大约400多K的文件读取数据时 xff0c 界面明显有停顿感 xff0c 于是尝试用NSThread建立子线程来负责读取文件数据 却发现子线程的运行速度奇慢无比 xff0c 刚开始
  • 报数游戏3

    题目描述 xff1a xfeff xfeff 一种报数游戏是从1开始连续报数 xff0c 如果报到7的倍数 xff08 7 xff0c 14 xff0c 21 xff0c 28 xff09 或者包含数字7的数 xff08 7 xff0c 1
  • c++ 关于流的重要帖子聚集

    1 关于clear 带参数版本 的2个例子 C 43 43 ios clear 用法及代码示例 纯净天空 2 关于unget的一个例子 unget C 43 43 标准库 开发文档 文江博客 3 关于peek的一个例子 C 43 43 中的
  • Mac无法访问Windows共享文件解决办法

    先按照网上教程 xff0c 在Windows下允许远程 xff0c 然后设置文件夹共享出来 xff0c 再在Mac上通过smb登录 xff0c 输入用户名和密码窗口总是抖动 xff0c 一直连接不上 xff0c 此时用另一台同一局域网的Wi
  • 虚拟机VMware安装ArchLinux及配置过程_详细202002_001#

    1 安装前准备工作 安装手册地址 xff1a https wiki archlinux org index php Installation guide版本为archlinux 2020 02 01 x86 64 isoVMware安装 x
  • VSCode C++环境配置

    VSCode C C 43 43 Windows 环境配置 第一次写博客 xff0c 编程小白 xff0c 码龄不足一年 xff0c 望大家批评改正 废话 许多像我一样的初级码农 xff0c 最开始接触的编程语言可能是C语言 xff0c 学
  • 服务器离线安装GitLab

    服务器离线安装GitLab并还原迁移的数据 1 下载gitlab的离线安装包 xff0c 默认el6 我下载的是el7 xff0c 以下简称el7 rpm 最好不要有openssh的rpm文件 2 登录服务器 xff0c 新建一个文件夹 s
  • leetcode刷题B部分

    目录 文章目录 目录50 Pow x n xff08 回到目录 目录 xff09 54 螺旋矩阵 59 xff08 回到目录 目录 xff09 58 最后一个单词的长度 xff08 回到目录 目录 xff09 59 螺旋矩阵 II 54 x
  • 【Java】字符串列表List<String>数字、字母、汉字混合排序(按中国人使用习惯排序)

    一 概要 本方法根据中国人使用习惯实现了 xff1a 总体按照按数字 字母 汉字升序 xff1b 数字之间按数值大小升序排序 xff1b 字母之间按ascii升序排序 xff1b 汉字之间按拼音升序排序 二 方法入口 span class
  • response.buffer用法

    不知道大家对Buffer了解多少 xff0c 很多人对这个概念都比较模糊 xff0c 尤其是在asp中 很多初学者在编写asp程序时很少用到这条语句 xff0c 下面我就来说说Buffer的用途以及它在asp程序中的作用 一 Buffer
  • 安装office时报错:an error occurred during the installation of assmbly component

    方法一 xff1a 删除office相关注册表 1 开始 xff0d xff0d 运行 xff0d xff0d 输入regedit xff0c 回车打开注册表找HKEY CURRENT USER Software Microsoft Off
  • mysql数据库的备份和恢复

    问题 想从我虚拟机上 xff0c 把数据库移到阿里云服务器上 解决方法 备份数据库 数据库名叫dddd mysqldump u root p span class hljs code 96 dddd 96 span gt dddd sql
  • Xcode如何打包Mac程序为 .dmg镜像文件

    打包Mac程序为 dmg镜像文件 获取可运行程序 按住crtl 43 b 编译程序 xff0c 编译完成之后打开Product文件夹 xff0c 选择编译好的程序 xff0c 鼠标右键点击Show in Finder 创建文件夹 在桌面新建
  • c modern approach chapter 17 中简单的复习

    一 程序remind c用动态内存实现 1 先回顾13 5中remind c的实现 xff0c 如下是自己看书以及自己的体会写成的程序 include lt stdio h gt include lt string h gt include
  • iOS Swift Crash的捕获

    iOS Swift Crash的捕获 crash捕获介绍 如果对crash捕获不太了解 xff0c 可以先参考这篇文章 本文进行Mach异常 43 Unix信号方式捕获crash NSException一般只在OC当中被捕获 xff0c 一
  • 基于TextRank的关键词、短语、摘要提取

    基于TextRank的关键词 短语 摘要提取 原创 2016年09月08日 18 20 59 标签 xff1a TextRank scala 自动文摘 3946 关于自动文摘 利用计算机将大量的文本进行处理 xff0c 产生简洁 精炼内容的
  • XCode9: iPhone is busy: Preparing debugger support for iPhone

    XCode9 iPhone is busy Preparing debugger support for iPhone Click on Window menuSelect Device and SimulatorsSelect your
  • 你会写开发文档吗

    你会写软件开发文档吗 xff1f 如今 xff0c 软件开发越来越复杂 xff0c 软件的功能也越来越丰富 而几乎所有成熟的商业软件 xff0c 都是一个开发团队齐心协力的血汗结晶 罗马不是一天建成的 xff0c 当我们震撼于Microso