如何编写帮助文档- FineBI帮助文档 FineBI帮助文档

文档创建者：doreen0813

历史版本：1

1、创建/编辑文档

注：新注册的用户，没有权限创建／编辑文档，点击右上角的激活即可

1）在顶部，点击用户名，有个绿色的“创建文档”按钮，点击即可开始创建，如下图：

2、文档编辑器

以下是编辑器图标功能说明，如下图：

源代码：一般不需要用到，如果需要的话可以点击切换至html源代码模式查看或编辑

一级目录：选中内容，点击一级目录即可，文档开头会调用一级目录的锚链

二级目录：选中内容，点击二级目录即可，文档开头暂时无法调用二级目录名，后面会进行改进

清除格式：清除其他html格式，比如从其他地方拷贝过来的内容有格式，可以选中内容之后，点击清除格式按钮，即可清除格式

路径：例如%FineBI%\webroot\WEB-INF\reportlets\doc\Advanced\Chart\NewColumnChart\AxisCustom2.cpt，这里%FineBI%

标识XXX软件的安装目录，比如%JAVA_HOME%标识Java的安装目录。

公式：例如CNMONEY(1200)等于壹仟贰佰圆整。

警告：例如注：单位可以为空，如果为空，则直接将number转换为人民币大写，否则先将number与单位的进制相乘，然后再将相乘的结果转换为人民币大写。

目录：例如插入>单元格元素>插入图表

SQL：例如=sql("FRDemo","SELECT * FROM STSCORE where CLASSNO = 'Class1' ",3,4)

图片：点击后选择图片上传，暂不支持调整大小，请在本地将图片调整为合适大小，图示规范参考图示规范。

链接：选中文本点击或者直接点击即可插入。

注意： ①复制粘贴网址的时候如果已含http抬头，需要去掉一个；

②如果是要在文档内打开连接，就选择在本窗口，如果是要跳到别的网站，就选择默认的在新窗口打开

特殊符号：点击即可插入

表格：点击选择行列数目即可插入

视频：点击即可插入链接，鉴于优酷等有广告，可以将视频放置到我们的云服务器上，具体联系传说哥（微信ID：frbiaoge QQ:2851322998）

代码：点击即可插入

3、文档分类

文档写好后需要确认在哪个分类中，如管理系统 >> 管理系统FAQ >> 权限管理常见问题；

若当前文档没有这个分类，需要创建一个新的分类。请联系@Susie（qq：2851322841）

4、标题

标题能否与搜索的问题一致/匹配。

1) 指南类和有关怎样做的文档：如何得到这样的结果？（例如：以图片显示内容）

2) 参考类的文档：功能/特性的名称？（例如：相邻连续分组）

3) 故障解决类的文档：我遇到的问题。（例如：安装设计器后无法预览报表）

5、描述

描述，和标题一样重要，能帮助阅读者快速地确定这篇文档是否是他们所需要的。

1) 指南类的和有关怎样做的文档：给出文档中需要的知识的大致摘要。

2) 参考类的文档：给出功能/特性的简单解释。

3) 故障解决类的文档：给出故障的大致描述以及现象。

注：描述中需包含或者介绍场景和设计器版本，jar包版本，插件版本等。

6、怎样编写一篇文档

1) 提供问题发生的环境（FineBI版本、操作系统、浏览器、服务器等）。

2) 确保完成任务所需的每个步骤都被包含。

操作步骤采用可以用列表的方式还原，如用1)、2)、3)…数字序号标注。

3) 文档编写力求简单明了，如有需要，配以适当的图表，以增强清晰性。

4) 不要用太口语化的文字，写完文档后，用初学者的眼光看一下文档，确认以新手的身份能否看懂。

注：新增功能如果跟主体功能的jar包或者插件版本不一致，需要给出说明。

7、参考模板

7.1通用问题

某种通用问题示例，具有一定代表性，可重复性

文档标题

1) 问题描述

2) 实现思路

3) 示例/操作步骤

（详细的操作步骤，阅读者根据示例，能够完整的还原出编写者要的示例；包含截图，超级链接，代码等）

4) 保存并发步

需要附上文档中演示的Demo模板（且模板能正常使用、代码能正常运行）

7.2故障类解决方案

文档标题

1) 问题描述（描述故障现象，根据描述能重现/还原故障，附上报错截图）

2) 原因

3) 解决方案

详细的操作步骤，确保完成任务所需的每个步骤都被包含，如果有模板需要提供模板

8、文档编辑流程

假设文档A目前最新版本是3，简称为A3，所有人都可以浏览A3，所有非违规用户都可以编辑A3；

一旦有用户编辑了A3发布了A4版本，比如这人是甲。那么甲和管理员看到的是A4，而其他人看到的依旧只是A3版本。且甲可以继续编辑发布，其他人都不能进行编辑，编辑发布后依旧是A4版本。

等到管理员审核批准A4后，其他普通用户和游客才能看到A4，以及编辑文档A4。

9、一篇好文档的标准

（1）准确：不会给人模棱两可的感觉

（2）清晰：不会给人写了很多但不知道写了啥的感觉

（3）完整：不会给人话说到一半戛然而止的感觉

（4）简洁：不会给人没话找话说的感觉

（5）有组织：不会给人不知道要去哪里看什么内容的感觉

（6）可读性好：不会给人每个字都认识但就是看不懂的感觉

（7）任务导向：不会给人跑题不说重点的感觉

9.1 一些小建议

（1）总分总：这个从小时候就常用的方式可以说是最符合人类思维习惯的结构。如果要用比较时髦的词就是『金字塔原理』，无论是正金字塔还是倒金字塔，可以根据需要进行选择。

（2）一图胜千言：涉及到诸多概念及其相关联系时，不要过多解释，画一个清晰的图，比什么效果都好。不需要太复杂，简单的 UML 已经足够。

（3）看人下菜：针对不同的群体要有不同的写作侧重点。如果是给运维人员看的，那么重点是要说清楚各个操作以及相关逻辑；如果是给非技术人员看的，一定要尽量『看图说话』，联系他们能够理解的概念来跨越不同职业的鸿沟；

（4）少即是多：文档太长，自己更新起来累，别人看起来也累，维护起来更累。所以去掉各类套话，说重点，并保证及时更新。

（5）理论结合实际：涉及需要操作或者修改的部分，一定要配上简单的例子，否则别人连如何去开始第一步都不知道。

已经是第一篇

已经是最后一篇

有帮助
没帮助
只是浏览

售前咨询电话

400-811-8890转1

在线技术支持

请前往「服务平台」，选择「在线支持」

热线电话：400-811-8890转2

在线QQ（将在2023.01.03关停）：800049425

总裁办24H投诉

热线电话：173-1278-1526

文档反馈

鼠标选中内容，快速反馈问题

鼠标选中存在疑惑的内容，即可快速反馈问题，我们将会跟进处理。

不再提示

10s后关闭

如何编写帮助文档