- 1、原创力文档(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。。
- 2、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 3、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
- 4、该文档为VIP文档,如果想要下载,成为VIP会员后,下载免费。
- 5、成为VIP后,下载本文档将扣除1次下载权益。下载后,不支持退款、换文档。如有疑问请联系我们。
- 6、成为VIP后,您将拥有八大权益,权益包括:VIP文档下载权益、阅读免打扰、文档格式转换、高级专利检索、专属身份标志、高级客服、多端互通、版权登记。
- 7、VIP文档为合作方或网友上传,每下载1次, 网站将根据用户上传文档的质量评分、类型等,对文档贡献者给予高额补贴、流量扶持。如果你也想贡献VIP文档。上传文档
查看更多
最新编辑
目的
通过阅读该手册,用户应该或能够达到什么目标。
范围
指明什么人员应该阅读该手册,或什么人员应该阅读本手册的哪些部分;阅读对象在阅读本手册之前应该掌握哪些知识,必要时应给出资料清单,以便用户查阅。
引言
3.1 背景
描述该《编程参考手册》所在项目的背景情况。
3.2 术语
列出《编程参考手册》中用到的专门术语的定义。
3.3 参考文献
列出编写《编程参考手册》时的参考文件、资料、技术标准,以及他们的作者、标题、编号、发布日期和出版单位。
编号 资料名称 简介 作者 日期 出版单位
头文件介绍
介绍该产品的 API 接口所使用到的头文件。在系统的“ include ”中应包含的头文件。
API 数据结构介绍
介绍该产品 API 所使用到的数据结构。可分模块进行说明。
最新编辑
5.1 模块一使用到的数据结构介绍:
5.2 模块二使用到的数据结构介绍:
5.3 模块三使用到的数据结构介绍:
6 该产品的 API 接口函数介绍
介绍 API 接口函数的功能,可分模块进行描述。
6.1 模块一 API 接口函数功能说明:(介绍接口函数实现的功能,入口参数,出口参数,使用方法,出错处理以及必要的说明等信息)
6.2 模块二 API 接口函数功能说明:
6.3 模块三 API 接口函数功能说明:
附录
7.1 本用户手册中相关文件说明: (可选)
包括本用户手册中涉及的各种输入数据文件、输出结果文件、中间数据文件的文件名组成、文件内容、文件存放路径和文件大小等说明。
【注意】描述这些文件时,应考虑用户是否有必要知道,避免泄漏公司技术秘密
7.1.1 错误提示信息:(可选)
通常可以以表的形式按照一定的顺序,例如按出错提示信息编号顺序、或按出错提示信息的字母顺序,给出出错提示信息的编号、提示信息、相应的解释、出错原因和解决办法。
7.1.2 命令速查表(可选):
通常可以以表的形式按照一定的顺序给出各种命令的概要 ( 包括命令名称、各种参数、及相应的功能介绍 ) ,以帮助有一定经验的用户进行快速查找所需信息。
7.1.3 其它信息 (可选):
任何其它有利于用户使用我们的软件、方便用户的信息都可以以附录的形式提供给用户。
最新编辑
〖目录说明〗:
文件页数超过 10 页,即采用自动生成的方式生成目录文件页数小于 10 页,不生成目录
附录:
1、以下部分为质量记录的页眉模板(在编写质量记录时,将其拷贝)。
北京易游无限科技有限公司
编程参考手册
文件编号
XX- QMSC- XX
版本 /0
V1.0.00/0
生效日期
200X-XX-XX
页码/页数
第3页共3页
2、“文件编号”的填写:作为质量记录的编号按照质量记录编号规则来进行填写。
原创力文档


文档评论(0)