程序说明文档怎么写
答案:1 悬赏:60 手机版
解决时间 2021-02-07 04:20
- 提问者网友：咪咪
- 2021-02-06 17:31
程序说明文档怎么写
最佳答案
- 五星知识达人网友：污到你湿
- 2021-02-06 18:55
问题一：如何写程序系统的说明文档 额……~肯定是有相关标准的吧~
话说我们每次做项目的文档也都不太一样~
我大概描述下我两年前的一个文档吧~（在邮箱里找到的）
1.项目概述：
项目名称：
项目用途：
2.需求分析
业务需求
用户需求
功能需求
性能需求
3. 系统功能模型
4.系统设计
4.1 总体设计
4.2 详细设计
4.2.1 系统的结构模型
4.2.2 系统的动态模型
4.2.3 主要程序说明
5.主要代码实现
其他描述：
6.测试：
黑盒测试：
白盒测试：
7.系统维护
8.参考文献
9.结束语问题二：程序设计流程说明文档怎么写 wenku.baidu.com/...3KMKdW问题三：支付宝应用程序的说明文件怎么写 在安装的时候可以查看下视频介绍啊。
这样就能对这个软件有很大的了解了。
通过应用宝安装这个软件就可以。
手机上安装应用宝软件，然后进行搜索。
就能搜索出需要的软件了。
从而就能查看软件的详细介绍呢。问题四：软件文档怎么写 下面的格式你可以参考一下，跟论文差不多的
主要还是要根据你实际编写的软件来写
*************************************
1．引言
1.1编写目的
1.2项目背景
1.3定义
1.4参考资料
2.2软件结构
3．程序描述
3.1功能
3.2性能
3.3输入项目
3.4输出项目
3．5算法
3．6程序逻辑
3.7接口
3.8存储分配
3.9限制条件
3.10测试要点问题五：详细设计说明书的程序注释 a. 加在模块首部的注释；b．加在各分枝点处的注释；c. 对各变量的功能、范围、缺省条件等所加的注释；d．对使用的逻辑所加的注释等等。F．3.11限制条件说明本程序运行中所受到的限制条件。F．3．12测试计划说明对本程序进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定。F．3.13尚未解决的问题说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。F．4程序2（标识符）设计说明用类似F．3的方式，说明第2个程序乃至第N个程序的设计考虑。......问题六：软件的功能需求分析要怎么写？ 5分1. 引言
1.1 编写目的:编写此文档的目的是进一步定制软件开发的细节问题,便于用户与开发商协调工作.本文档面向的读者主要是项目委托单位的管理人员.希望能使本软件开发工作更具体.
1.2 项目背景
1.2.1项目委托单位:****公司
1.2.2开发单位:***公司
1.3 定义
1.4 参考资料
2. 任务概述
2.1 目标:
决策支持:根据公司的要求及时提供所需报表及文件,并在适当时候对各部门领导给予销售及进货等方面的提示
提高效率:利用软件进行管理,避免人工管理的失误以及 延迟性,从而实现高效率的管理.
2.2 运行环境:
硬件方面:Pentium级处理芯片
1兆显存的兼容显卡
256色,800*600的兼容显示器
标准兼容打印机
软件方面: WIN95操作系统
2.3 条件与限制:
编程用计算机一台
完成期限2000/7/1
无资金供给
3. 数据概述
数据流程图如下:
3.1 静态数据:包括系统登录密码,各数据库所在位置,系统分析原始数据
3.2 动态数据:包括各数据库内各项显示数据,用户登录信息,系统时间
3.3 数据库描述:
人事管理数据库:公司内人员的个人详细信息,包括档案信息
销售管理数据库:当日销售记录及以前的销售统计,用于销售分析
财务管理数据库:公司内部账目及收支情况详表
技术管理数据库:公司所需各技术档案的详细记录(包括文档)
3.4 数据字典:
数据流词条描述:
1.数据流名:登录信息
来源:用户的输入
去向:系统内部检验部分
组成:用户名,密码
流通量:每次登录输入一次
2.数据流名:登录结果
来源:系统
去向:用户
组成:返回信息
流通量:每次登录返回一次
3.数据流名:输入修改信息
来源:用户
去向:系统判断部分
组成:根据各数据库内容而不同
流通量:依用户输入而定
4.数据流名:反馈信息
来源:系统判断部分
去向:用户
组成:系统经判断后发回的字符数据
流通量: 依系统当前信息而定
5.数据流名:识别信息
来源:系统内部检验部分
去向:系统判断部分
组成:系统各数据库的标识信息
流通量:用户每次输入流通一次
6.数据流名:处理信息
来源:系统判断部分
去向:各数据库处理部分
组成:读取/修改标识,读取/修改的变量名称
流通量:用户每次输入流通一次
7.数据流名:读取修改
来源:系统判断部分
去向:系统各数据库
组成:读取/修改标识,读取/修改内容
流通量: 用户每次输入流通一次
数据文件词条描述:
1.数据文件名:人事数据
简述:存储人员信息
数据文件组成:人员的各项信息(以CString类型为主)
2.数据文件名:销售数据
简述:存储当日及从前的销售记录
数据文件组成:销售的各项信息
3.数据文件名:财务数据
简述:存储财务管理信息
数据文件组成:财务管理的各项记录
4.数据文件名:技术数据
简述:存储公司内部使用的技术档案信息
数据文件组成:技术档案名称,内容
加工逻辑词条描述:
1.加工名:检验
简要描述:判断用户......余下全文>>问题七：什么是程序设计说明书 5分开发人员:黄涛 学号:2004551425 计算机3班
开发日期:2006年2月22日
版本:————
程序功能:建立一个简单的学生管理系统,存储的学生信息至少包括:班级,学号,姓名,各个科目的成绩.能够完成的功能至少有:输入,查询,修改,删除学生信息,计算学生的平均成绩,名次,按某个科目的成绩排序输出.注意:只能采用文件形式管理,不得采用现成的数据库管理.
开发环境:程序在Visual c++ 6.0下开发,编译工具为Vc 6.0,操作系统为Windows XP.
数据结构和算法:本程序包含数个函数,且用链表存储信息,每个节点包含一个学生的信息.
本程序中有两种结构体:
typedef struct student{ typedef struct score{
char name[MAX+1]; char name[MAX+1];
int num; int aver;
char class[MAX+1]; struct score *next;
int Chinese; }Sco,*SCO;
int English;
int math;
int computer;
struct student *next;
}Stu,*STU;
程序流程图如下:
*****主程序流程图 *****
主要函数功能说明
函数原型:STU insert( ); 功能:插入学生信息
入口参数:无 出口参数:无 返回值:无
函数原型:STU xiugai( );功能:修改学生信息
入口参数:无 出口参数:无 返回值:无
函数原型:STU shanchu( );功能:删除学生信息
入口参数:无 出口参数:无 返回值:无
函数原型:STU find( );功能:查找学生信息
入口参数:无 出口参数:无 返回值:无
函数原型:int xianshi( );功能:显示文件内容
入口参数:无 出口参数:无 返回值:无
函数原型:int eaverage( );功能:计算学生名次
入口参数:无 出口参数:无 返回值:无
函数原型:int chinese( );功能:语文成绩
入口参数:无 出口参数:无 返回值:无
函数原型:int english( );功能:英语成绩
入口参数:无 出口参数:无 返回值:无
函数原型:int math( ); 功能:数学成绩
入口参数:无 出口参数:无 返回值:无
函数原型:int computer( );功能:计算机成绩
入口参数:无 出口参数:无 返回值:无
函数原型:void fresh( );功能: 清屏
入口参数:无 出口参数:无 返回值:无
—————————— 说明书结束 ——————————————————
—————— 源程序 ————————
#include
#include
#include
#include
#include
#define LEN sizeof(struct student)
#define NEM sizeof(struct score)
#define MAX 8
typedef struct student{......余下全文>>问题八：软件设计的基本步骤是什么 软件开发是指一个软件项目的开发，如市场调查，需求分析，可行性分析，初步设计，详细设计，形成文档，建立初步模型，编写详细代码，测试修改，发布等。
软件是怎么样开发出来的
第一个步骤是市场调研，技术和市场要结合才能体现最大价值。
第二个步骤是需求分析，这个阶段需要出三样东西，用户视图，数据词典和用户操作手 册。
用户视图 是该软件用户（包括终端用户和管理用户）所能看到的页面样式，这里面包含了 很多操作方面的流程和条件。
数据词典 是指明数据逻辑关系并加以整理的东东，完成了数据词典，数据库的设计就完成了一半多。
用户操作手册是指明了操作流程的说明书。
请注意，用户操作流程和用户视图是由需求决定的，因此应该在软件设计之前完成，完成这些，就为程序研发提供了约束和准绳，很遗憾太多公司都不是这样做的，因果颠倒，顺序不分，开发工作和实际需求往往因此产生隔阂脱节的现象。
需求分析，除了以上工作，笔者以为作为项目设计者应当完整的做出项目的性能需求说明 书，因为往往性能需求只有懂技术的人才可能理解，这就需要技术专家和需求方（客户或公司市场部门）能够有真正的沟通和了解。
第三个步骤是概要设计，将系统功能模块初步划分，并给出合理的研发流程和资源要求。
作为快速原型设计方法，完成概要设计就可以进入编码阶段了，通常采用这种方法是因为涉及的研发任务属于新领域，技术主管人员一上来无法给出明确的详细设计说明书，但是 并不是说详细设计说明书不重要，事实上快速原型法在完成原型代码后，根据评测结果和 经验教训的总结，还要重新进行详细设计的步骤。
第四个步骤是详细设计，这是考验技术专家设计思维的重要关卡，详细设计说明书应当把 具体的模块以最’干净’的方式(黑箱结构）提供给编码者，使得系统整体模块化达到最 大；一份好的详细设计说明书，可以使编码的复杂性减低到最低，实际上，严格的讲详细 设计说明书应当把每个函数的每个参数的定义都精精细细的提供出来，从需求分析到概要 设计到完成详细设计说明书，一个软件项目就应当说完成了一半了。换言之，一个大型软 件系统在完成了一半的时候，其实还没有开始一行代码工作。
那些把作软件的程序员简单理解为写代码的，就从根子上犯了错误了。
第五个步骤是编码，在规范化的研发流程中，编码工作在整个项目流程里最多不会超过1/ 2，通常在1/3的时间，所谓磨刀不误砍柴功，设计过程完成的好，编码效率就会极大提 高，编码时不同模块之间的进度协调和协作是最需要小心的，也许一个小模块的问题就可能影响了整体进度，让很多程序员因此被迫停下工作等待，这种问题在很多研发过程中都 出现过。
编码时的相互沟通和应急的解决手段都是相当重要的，对于程序员而言，bug永 远存在，你必须永远面对这个问题，大名鼎鼎的微软，可曾有连续三个月不发补丁的时候 吗？从来没有！
第六个步骤是测试
测试有很多种：
按照测试执行方，可以分为内部测试和外部测试
按照测试范围，可以分为模块测试和整体联调
按照测试条件，可以分为正常操作情况测试和异常情况测试
按照测试的输入范围，可以分为全覆盖测试和抽样测试
以上都很好理解，不再解释。
总之，测试同样是项目研发中一个相当重要的步骤，对于一个大型软件，3个月到1年的外部测试都是正常的，因为永远都会又不可预料的问题存在。
完成测试后，完成验收并完成最后的一些帮助文档，整体项目才算告一段落，当然日后少不了升级，修补等等工作，只要不是想通过一锤子买卖骗钱，就要不停的跟踪软件的运营 状况并......余下全文>>问题九：android app开发文档怎么写 ：软件需求文档格式的标准写法 1．引言 1．1 编写目的 · 阐明开发本软件的目的； 1．2 项目背景 · 标识待开发软件产品的名称、代码； · 列出本项目的任务提出者、项目负责人、系统分析员、系统设计员、程序设计员、程序员、资料员以及与本项目开展问题十：写c语言的说明文档时，“程序的设计”需要写些什么？ 程序设计就是说你这个程序是怎么设计出来的~
你可以将你所写的函数一一列出来 然后做个骇细的函数分析就OK了
比如说 这个函数实现了怎么样的功能啊 是怎么实现的啊
话说我们每次做项目的文档也都不太一样~
我大概描述下我两年前的一个文档吧~（在邮箱里找到的）
1.项目概述：
项目名称：
项目用途：
2.需求分析
业务需求
用户需求
功能需求
性能需求
3. 系统功能模型
4.系统设计
4.1 总体设计
4.2 详细设计
4.2.1 系统的结构模型
4.2.2 系统的动态模型
4.2.3 主要程序说明
5.主要代码实现
其他描述：
6.测试：
黑盒测试：
白盒测试：
7.系统维护
8.参考文献
9.结束语问题二：程序设计流程说明文档怎么写 wenku.baidu.com/...3KMKdW问题三：支付宝应用程序的说明文件怎么写 在安装的时候可以查看下视频介绍啊。
这样就能对这个软件有很大的了解了。
通过应用宝安装这个软件就可以。
手机上安装应用宝软件，然后进行搜索。
就能搜索出需要的软件了。
从而就能查看软件的详细介绍呢。问题四：软件文档怎么写 下面的格式你可以参考一下，跟论文差不多的
主要还是要根据你实际编写的软件来写
*************************************
1．引言
1.1编写目的
1.2项目背景
1.3定义
1.4参考资料
2.2软件结构
3．程序描述
3.1功能
3.2性能
3.3输入项目
3.4输出项目
3．5算法
3．6程序逻辑
3.7接口
3.8存储分配
3.9限制条件
3.10测试要点问题五：详细设计说明书的程序注释 a. 加在模块首部的注释；b．加在各分枝点处的注释；c. 对各变量的功能、范围、缺省条件等所加的注释；d．对使用的逻辑所加的注释等等。F．3.11限制条件说明本程序运行中所受到的限制条件。F．3．12测试计划说明对本程序进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定。F．3.13尚未解决的问题说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。F．4程序2（标识符）设计说明用类似F．3的方式，说明第2个程序乃至第N个程序的设计考虑。......问题六：软件的功能需求分析要怎么写？ 5分1. 引言
1.1 编写目的:编写此文档的目的是进一步定制软件开发的细节问题,便于用户与开发商协调工作.本文档面向的读者主要是项目委托单位的管理人员.希望能使本软件开发工作更具体.
1.2 项目背景
1.2.1项目委托单位:****公司
1.2.2开发单位:***公司
1.3 定义
1.4 参考资料
2. 任务概述
2.1 目标:
决策支持:根据公司的要求及时提供所需报表及文件,并在适当时候对各部门领导给予销售及进货等方面的提示
提高效率:利用软件进行管理,避免人工管理的失误以及 延迟性,从而实现高效率的管理.
2.2 运行环境:
硬件方面:Pentium级处理芯片
1兆显存的兼容显卡
256色,800*600的兼容显示器
标准兼容打印机
软件方面: WIN95操作系统
2.3 条件与限制:
编程用计算机一台
完成期限2000/7/1
无资金供给
3. 数据概述
数据流程图如下:
3.1 静态数据:包括系统登录密码,各数据库所在位置,系统分析原始数据
3.2 动态数据:包括各数据库内各项显示数据,用户登录信息,系统时间
3.3 数据库描述:
人事管理数据库:公司内人员的个人详细信息,包括档案信息
销售管理数据库:当日销售记录及以前的销售统计,用于销售分析
财务管理数据库:公司内部账目及收支情况详表
技术管理数据库:公司所需各技术档案的详细记录(包括文档)
3.4 数据字典:
数据流词条描述:
1.数据流名:登录信息
来源:用户的输入
去向:系统内部检验部分
组成:用户名,密码
流通量:每次登录输入一次
2.数据流名:登录结果
来源:系统
去向:用户
组成:返回信息
流通量:每次登录返回一次
3.数据流名:输入修改信息
来源:用户
去向:系统判断部分
组成:根据各数据库内容而不同
流通量:依用户输入而定
4.数据流名:反馈信息
来源:系统判断部分
去向:用户
组成:系统经判断后发回的字符数据
流通量: 依系统当前信息而定
5.数据流名:识别信息
来源:系统内部检验部分
去向:系统判断部分
组成:系统各数据库的标识信息
流通量:用户每次输入流通一次
6.数据流名:处理信息
来源:系统判断部分
去向:各数据库处理部分
组成:读取/修改标识,读取/修改的变量名称
流通量:用户每次输入流通一次
7.数据流名:读取修改
来源:系统判断部分
去向:系统各数据库
组成:读取/修改标识,读取/修改内容
流通量: 用户每次输入流通一次
数据文件词条描述:
1.数据文件名:人事数据
简述:存储人员信息
数据文件组成:人员的各项信息(以CString类型为主)
2.数据文件名:销售数据
简述:存储当日及从前的销售记录
数据文件组成:销售的各项信息
3.数据文件名:财务数据
简述:存储财务管理信息
数据文件组成:财务管理的各项记录
4.数据文件名:技术数据
简述:存储公司内部使用的技术档案信息
数据文件组成:技术档案名称,内容
加工逻辑词条描述:
1.加工名:检验
简要描述:判断用户......余下全文>>问题七：什么是程序设计说明书 5分开发人员:黄涛 学号:2004551425 计算机3班
开发日期:2006年2月22日
版本:————
程序功能:建立一个简单的学生管理系统,存储的学生信息至少包括:班级,学号,姓名,各个科目的成绩.能够完成的功能至少有:输入,查询,修改,删除学生信息,计算学生的平均成绩,名次,按某个科目的成绩排序输出.注意:只能采用文件形式管理,不得采用现成的数据库管理.
开发环境:程序在Visual c++ 6.0下开发,编译工具为Vc 6.0,操作系统为Windows XP.
数据结构和算法:本程序包含数个函数,且用链表存储信息,每个节点包含一个学生的信息.
本程序中有两种结构体:
typedef struct student{ typedef struct score{
char name[MAX+1]; char name[MAX+1];
int num; int aver;
char class[MAX+1]; struct score *next;
int Chinese; }Sco,*SCO;
int English;
int math;
int computer;
struct student *next;
}Stu,*STU;
程序流程图如下:
*****主程序流程图 *****
主要函数功能说明
函数原型:STU insert( ); 功能:插入学生信息
入口参数:无 出口参数:无 返回值:无
函数原型:STU xiugai( );功能:修改学生信息
入口参数:无 出口参数:无 返回值:无
函数原型:STU shanchu( );功能:删除学生信息
入口参数:无 出口参数:无 返回值:无
函数原型:STU find( );功能:查找学生信息
入口参数:无 出口参数:无 返回值:无
函数原型:int xianshi( );功能:显示文件内容
入口参数:无 出口参数:无 返回值:无
函数原型:int eaverage( );功能:计算学生名次
入口参数:无 出口参数:无 返回值:无
函数原型:int chinese( );功能:语文成绩
入口参数:无 出口参数:无 返回值:无
函数原型:int english( );功能:英语成绩
入口参数:无 出口参数:无 返回值:无
函数原型:int math( ); 功能:数学成绩
入口参数:无 出口参数:无 返回值:无
函数原型:int computer( );功能:计算机成绩
入口参数:无 出口参数:无 返回值:无
函数原型:void fresh( );功能: 清屏
入口参数:无 出口参数:无 返回值:无
—————————— 说明书结束 ——————————————————
—————— 源程序 ————————
#include
#include
#include
#include
#include
#define LEN sizeof(struct student)
#define NEM sizeof(struct score)
#define MAX 8
typedef struct student{......余下全文>>问题八：软件设计的基本步骤是什么 软件开发是指一个软件项目的开发，如市场调查，需求分析，可行性分析，初步设计，详细设计，形成文档，建立初步模型，编写详细代码，测试修改，发布等。
软件是怎么样开发出来的
第一个步骤是市场调研，技术和市场要结合才能体现最大价值。
第二个步骤是需求分析，这个阶段需要出三样东西，用户视图，数据词典和用户操作手 册。
用户视图 是该软件用户（包括终端用户和管理用户）所能看到的页面样式，这里面包含了 很多操作方面的流程和条件。
数据词典 是指明数据逻辑关系并加以整理的东东，完成了数据词典，数据库的设计就完成了一半多。
用户操作手册是指明了操作流程的说明书。
请注意，用户操作流程和用户视图是由需求决定的，因此应该在软件设计之前完成，完成这些，就为程序研发提供了约束和准绳，很遗憾太多公司都不是这样做的，因果颠倒，顺序不分，开发工作和实际需求往往因此产生隔阂脱节的现象。
需求分析，除了以上工作，笔者以为作为项目设计者应当完整的做出项目的性能需求说明 书，因为往往性能需求只有懂技术的人才可能理解，这就需要技术专家和需求方（客户或公司市场部门）能够有真正的沟通和了解。
第三个步骤是概要设计，将系统功能模块初步划分，并给出合理的研发流程和资源要求。
作为快速原型设计方法，完成概要设计就可以进入编码阶段了，通常采用这种方法是因为涉及的研发任务属于新领域，技术主管人员一上来无法给出明确的详细设计说明书，但是 并不是说详细设计说明书不重要，事实上快速原型法在完成原型代码后，根据评测结果和 经验教训的总结，还要重新进行详细设计的步骤。
第四个步骤是详细设计，这是考验技术专家设计思维的重要关卡，详细设计说明书应当把 具体的模块以最’干净’的方式(黑箱结构）提供给编码者，使得系统整体模块化达到最 大；一份好的详细设计说明书，可以使编码的复杂性减低到最低，实际上，严格的讲详细 设计说明书应当把每个函数的每个参数的定义都精精细细的提供出来，从需求分析到概要 设计到完成详细设计说明书，一个软件项目就应当说完成了一半了。换言之，一个大型软 件系统在完成了一半的时候，其实还没有开始一行代码工作。
那些把作软件的程序员简单理解为写代码的，就从根子上犯了错误了。
第五个步骤是编码，在规范化的研发流程中，编码工作在整个项目流程里最多不会超过1/ 2，通常在1/3的时间，所谓磨刀不误砍柴功，设计过程完成的好，编码效率就会极大提 高，编码时不同模块之间的进度协调和协作是最需要小心的，也许一个小模块的问题就可能影响了整体进度，让很多程序员因此被迫停下工作等待，这种问题在很多研发过程中都 出现过。
编码时的相互沟通和应急的解决手段都是相当重要的，对于程序员而言，bug永 远存在，你必须永远面对这个问题，大名鼎鼎的微软，可曾有连续三个月不发补丁的时候 吗？从来没有！
第六个步骤是测试
测试有很多种：
按照测试执行方，可以分为内部测试和外部测试
按照测试范围，可以分为模块测试和整体联调
按照测试条件，可以分为正常操作情况测试和异常情况测试
按照测试的输入范围，可以分为全覆盖测试和抽样测试
以上都很好理解，不再解释。
总之，测试同样是项目研发中一个相当重要的步骤，对于一个大型软件，3个月到1年的外部测试都是正常的，因为永远都会又不可预料的问题存在。
完成测试后，完成验收并完成最后的一些帮助文档，整体项目才算告一段落，当然日后少不了升级，修补等等工作，只要不是想通过一锤子买卖骗钱，就要不停的跟踪软件的运营 状况并......余下全文>>问题九：android app开发文档怎么写 ：软件需求文档格式的标准写法 1．引言 1．1 编写目的 · 阐明开发本软件的目的； 1．2 项目背景 · 标识待开发软件产品的名称、代码； · 列出本项目的任务提出者、项目负责人、系统分析员、系统设计员、程序设计员、程序员、资料员以及与本项目开展问题十：写c语言的说明文档时，“程序的设计”需要写些什么？ 程序设计就是说你这个程序是怎么设计出来的~
你可以将你所写的函数一一列出来 然后做个骇细的函数分析就OK了
比如说 这个函数实现了怎么样的功能啊 是怎么实现的啊
我要举报
如以上回答内容为低俗、色情、不良、暴力、侵权、涉及违法等信息，可以点下面链接进行举报！
点此我要举报以上问答信息
大家都在看
推荐资讯