1、创建/编辑文档编辑
1)在顶部,有个绿色的“创建文档”按钮,点击即可开始创建
2)创建之前请点击分类查看同类文档是否已存在,或使用搜索功能来确认
3)若文档已存在,但需求完善,可以点击“编辑”按钮
编辑完成后,点击发布。如果是编辑的已有文档,需要填写详细的修改原因,这样才能更容易通过管理员审核。
文档通过审核后会自动获得积分,点击自己的用户名还可查看创建或编辑过的文档。
2、文档编辑器编辑
以下是编辑器图标功能说明
源代码:一般不需要用到,如果需要的话可以点击切换至html源代码模式查看或编辑
一级目录:例如本文档,选中一级目录名称后点击即可,文档开头会调用一级目录的锚链
二级目录:例如本文档,选中一级目录名称后点击即可,文档开头暂时无法调用二级目录名,后面会进行改进
路径:例如%FR_HOME%\WebReport\WEB-INF\reportlets\doc\Advanced\Chart\NewColumnChart\AxisCustom2.cpt
公式:例如CNMONEY(1200)等于壹仟贰佰圆整。
警告:例如备注:单位可以为空,如果为空,则直接将number转换为人民币大写,否则先将number与单位的进制相乘,然后再将相乘的结果转换为人民币大写。
目录:例如插入>单元格元素>插入图表
SQL:例如=sql("FRDemo","SELECT * FROM STSCORE where CLASSNO = 'Class1' ",3,4)
图片:点击后选择图片上传,暂不支持调整大小,请在本地将图片调整为合适大小
链接:选中文本点击或者直接点击即可插入。
注意: ①复制粘贴网址的时候如果已含http抬头,需要去掉一个;
②如果是要在文档内打开连接,就选择在本窗口,如果是要跳到别的网站,就选择默认的在新窗口打开
特殊符号:点击即可插入
表格:点击选择行列数目即可插入
视频:点击即可插入链接,鉴于优酷等有广告,可以将视频放置到我们的云服务器上,具体联系传说哥(微信ID:frbiaoge QQ:2851322998)
代码:点击即可插入
3、文档分类编辑
4、标题编辑
5、描述编辑
6、怎样编写一篇文档编辑
7、参考模板编辑
某种通用问题示例,具有一定代表性,可重复性
8、文档编辑流程编辑
9、一篇好文档的标准编辑
(1)准确:不会给人模棱两可的感觉
(2)清晰:不会给人写了很多但不知道写了啥的感觉
(3)完整:不会给人话说到一半戛然而止的感觉
(4)简洁:不会给人没话找话说的感觉
(5)有组织:不会给人不知道要去哪里看什么内容的感觉
(6)可读性好:不会给人每个字都认识但就是看不懂的感觉
(7)任务导向:不会给人跑题不说重点的感觉。
(1)总分总:这个从小时候就常用的方式可以说是最符合人类思维习惯的结构。如果要用比较时髦的词就是『金字塔原理』,无论是正金字塔还是倒金字塔,可以根据需要进行选择。
(2)一图胜千言:涉及到诸多概念及其相关联系时,不要过多解释,画一个清晰的图,比什么效果都好。不需要太复杂,简单的 UML 已经足够。
(3)看人下菜:针对不同的群体要有不同的写作侧重点。如果是给运维人员看的,那么重点是要说清楚各个操作以及相关逻辑;如果是给非技术人员看的,一定要尽量『看图说话』,联系他们能够理解的概念来跨越不同职业的鸿沟;
(4)少即是多:文档太长,自己更新起来累,别人看起来也累,维护起来更累。所以去掉各类套话,说重点,并保证及时更新。
(5)理论结合实际:涉及需要操作或者修改的部分,一定要配上简单的例子,否则别人连如何去开始第一步都不知道。