知识库(WIKI)文件目录结构

WIKI的文章页面就如果Windows系统中的文件夹一样,通过本章节,你将了解我们约定的文件结构规则。

如图中示例,

functions:accounts 这个页面指向了,functions目录下的accounts页面。

而 functions:accounts:editview 这个则指向了,functions目录中accounts目录中的editview页面。

为保持文件风格统一,资产云文件结构约定如下

一级目录二级目录页面文件名说明
bestpratice按组织名称进行定义尽可能放置于二级目录之后最佳业务实践,用于展示行业实践,管理标准等偏业务应用层的事项
concepts 直接放置于一级目录
en待定 页面的英文版本对照,一般不使用
functions严格按模块名 ,如hat_assets, ham_wo首页的索引放在一级目录,用模块名。模块的创建与编辑说明用editeview命名,放置于二级目录下。模块的其它功能,与editview类似,并且与系统功能保持同名。系统功能的详细使用说明文件。注意:保持模块名与视图名在系统中一致非常重要,通过这种对应,未来可以将帮助文件直接嵌入到系统帮助中,实现在系统使用页面中查看帮助可自动跳转到知识库。
implementation按行业/场景进行细分待定,目前按需要自行定义说明系统实施(设计、配置等过程中)的使用说明
playgroundplayground系统自带,用于编辑器上手试用。(学习编辑器功能与语法规则)
roadmap遗留目录,不再使用遗留目录,不再使用遗留目录,不再使用
talk 系统自带,用于记录留言
trm见下方说明见下方说明技术开发相关的详细内容trm是Technical Reference Manual的缩写。
trmbasic按实际需要进行命名用于记录与详细描述SuiteCRM/SugarCRM标准功能框架的技术知识
trmhandalm按实际需要进行命名用于记录与详细handalm中特有的(SuiteCRM/SugarCRM)以外的框架性技术知识
trmpractice按实际需要进行命名用于记录与详细描述开发过程中的一些常见场景处理方式与案例
userguide待定待定,目前按需要自行定义这是按用户需求的视角对系统功能的重新组织索引。注意:在编写功能说明时,有限确保functions中的对应是完整和正确的。目前此文件夹下的内容较乱,需要进一步整理。
wikiwiki框架本身的内容,如WKI使用的说明,WKI中的目录结构等。

WIKI是一种为了让知识快速衍生的系统,因此在新增知识页时的方法与传统文件管理不同。

如果需要新增一个页面,你需要:

  1. 首先找到你这个页面从哪个页面来源。(比如某个功能描述页,可能来源于用户手册的目录)
  2. 在来源的页面中, 新增一个文字说明这个页面,并在链接中建立一个Internal Link(内部页面)。在Internal Link中输入你预期的文件路径与名称,例如: functions:accounts:editview(此时页面还不 存在,没关系)
  3. 在完成第2步并保存后,你新建了一个链接。但由于被链接的页面还不存在,因此来源页面中,这个标题链接为红色(表示空链接)
  4. 点开红色的空链接,弹出页面,提示页面不保存,点右上的编辑按钮直接进行编辑。参考:格式语法与编辑器使用说明
  5. 编辑完成保存即可。这时如果回到来源页面,会发现红色的链接变成了正常颜色。

文件可以重新命名么?

可以的,由管理员在后台可以进行处理。

你可以使用 左边栏的【 媒体管理器】按目录对图片进行上传与 修改。