教你如何写一篇帮助文档

楼主
欢迎找我唠嗑

2.1、文档来源
1) 原创,自己在使用finereport的过程中遇到的问题,并解决的;
2) 论坛里的帖子,有些方案是可以整理成文档的,当然需要自己验证方案是否正确http://bbs.fanruan.com/(如果内容来源于论坛帖子,内容重复度超过50%,就是侵权了,不奖励。)

2.2、文档分类
文档写好后需要确认在哪个分类中,如报表应用 >> 报表FAQ >> 空指针错误
若当前文档没有这个分类,需要创建一个新的分类,需要在文档中提出

2.3、标题
标题能否与搜索的问题一致/匹配。
1) 指南类和有关怎样做的文档:如何得到这样的结果?(例如:以图片显示内容)
2) 参考类的文档:功能/特性的名称?(例如:相邻连续分组)
3) 故障解决类的文档:我遇到的问题。(例如:安装设计器后无法预览报表)

2.4、描述
描述,和标题一样重要,能帮助阅读者快速地确定这篇文档是否是他们所需要的。
1) 指南类的和有关怎样做的文档:给出文档中需要的知识的大致摘要。
2) 参考类的文档:给出功能/特性的简单解释。
3) 故障解决类的文档:给出故障的大致描述以及现象。

2.5、怎样编写一篇文档
1) 提供问题发生的环境(FR版本、操作系统、浏览器、服务器等)。
2) 确保完成任务所需的每个步骤都被包含。
操作步骤采用可以用列表的方式还原,如用1)、2)、3)…数字序号标注。
3) 文档编写力求简单明了,如有需要,配以适当的图表,以增强清晰性。
4) 不要用太口语化的文字,写完文档后,用初学者的眼光看一下文档,确认以新手的身份能否看懂。

2.6、参考模板

2.6.1某种通用问题的示例,具有一定的代表性,可重复性
文档标题
1) 问题描述
2) 实现思路
3) 示例/操作步骤
(详细的操作步骤,阅读者根据示例,能够完整的还原出编写者要的示例;包含截图,超级链接,代码等)
4) 保存并发步
需要附上文档中演示的Demo模板(且模板能正常使用、代码能正常运行)

2.6.2故障类的解决方案
文档标题
1) 问题描述(描述故障现象,根据描述能重现/还原故障,附上报错截图
2) 原因
3) 解决方案
详细的操作步骤,确保完成任务所需的每个步骤都被包含,如果有模板需要提供模板



附:

普通文档(典型应用、FAQ、各种报错的解决方案等)

二次开发类文档(JS的实例和引擎API类等二次开发的内容)











分享扩散:

沙发
发表于 2015-8-3 09:15:47
沙发。。。。。。。
板凳
发表于 2015-8-3 09:16:59
板凳。。。。
地板
发表于 2015-8-3 09:18:19
开始 了   
5楼
发表于 2015-8-3 09:26:37
我来了,,,还是不明白怎么写,最后提交什么格式?
网页格式?word?
6楼
发表于 2015-8-3 09:36:13
仔细等待细节的完善
7楼
发表于 2015-8-3 10:10:52
8楼
发表于 2015-8-3 10:32:14
听起来不错
9楼
发表于 2015-8-3 11:48:26
围观。。。
10楼
发表于 2015-8-4 15:01:01
感觉好麻烦···
11楼
发表于 2015-8-5 11:03:56
12楼
发表于 2015-8-5 11:09:24
进来参观一下
13楼
发表于 2015-9-4 14:56:39
持续关注中,谢谢分享!{:8_209:}
14楼
发表于 2016-5-3 12:14:33
学习,借鉴!
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

返回顶部 返回列表