历史版本9 :帮助文档编辑器 返回文档
编辑时间:
内容长度:图片数:目录数:
修改原因:
目录:
1、文档分类编辑
文档写好后需要确认在哪个分类中，如 报表应用 >> 报表FAQ >> 空指针错误；
若当前文档没有这个分类，需要创建一个新的分类。
2、标题编辑
标题能否与搜索的问题一致/匹配。
1) 指南类和有关怎样做的文档：如何得到这样的结果？（例如：以图片显示内容）
2) 参考类的文档：功能/特性的名称？（例如：相邻连续分组）
3) 故障解决类的文档：我遇到的问题。（例如：安装设计器后无法预览报表）
3、描述编辑
描述，和标题一样重要，能帮助阅读者快速地确定这篇文档是否是他们所需要的。
1) 指南类的和有关怎样做的文档：给出文档中需要的知识的大致摘要。
2) 参考类的文档：给出功能/特性的简单解释。
3) 故障解决类的文档：给出故障的大致描述以及现象。
4、怎样编写一篇文档编辑
1) 提供问题发生的环境（FR版本、操作系统、浏览器、服务器等）。
2) 确保完成任务所需的每个步骤都被包含。
操作步骤采用可以用列表的方式还原，如用1)、2)、3)…数字序号标注。
3) 文档编写力求简单明了，如有需要，配以适当的图表，以增强清晰性。
4) 不要用太口语化的文字，写完文档后，用初学者的眼光看一下文档，确认以新手的身份能否看懂。
5、参考模板编辑
5.1通用问题
某种通用问题示例，具有一定代表性，可重复性
文档标题
1) 问题描述
2) 实现思路
3) 示例/操作步骤
（详细的操作步骤，阅读者根据示例，能够完整的还原出编写者要的示例；包含截图，超级链接，代码等）
4) 保存并发步
需要附上文档中演示的Demo模板（且模板能正常使用、代码能正常运行）
5.2故障类解决方案
文档标题
1) 问题描述（描述故障现象，根据描述能重现/还原故障，附上报错截图）
2) 原因
3) 解决方案
详细的操作步骤，确保完成任务所需的每个步骤都被包含，如果有模板需要提供模板