技术类产品标准文档格式

@GuoYongfeng 2016-07-09 02:57:10发表于 iuap-design/blog

以下为用友FED团队文档的写作标准格式,适用于团队的的技术类产品,帮助用户更好更快的使用和认识我们的技术产品

文档的标题

1.安装或下载(download)

在这里说明获取资源的方式

整体的介绍,原理,相关的生态等

2.快速使用或起步(getting started)

基本的示例,一定要用简单并且推荐的方式给出示例,让用户一看就懂,粘贴复制就能运行使用。
示例的代码要完整,依赖到的资源要用代码或是文档的方式说清楚。

示例可以分层次,简单的,进阶的,综合的,都可以。

3.概述或介绍(instruction)

说清楚现状,我们为什么要做,我们所提供的框架、插件或是类库的原理是什么,功能特性是什么,适用的场景,能解决什么问题,等等,都可以扩展介绍,让用户更深入的了解和继续使用。

4.使用文档(document)

5.API介绍(API)

6.详细示例(Demo)

7.其他拓展标题

进阶体验,如何构建应用,对比市场其他同类技术产品等