Wiki 文档管理

产品功能介绍

Wiki 是一个应交流需要,可随时进行“增删改”的知识库,可用于记录整个项目的来龙去脉,展示当前项目状态,也可让项目成员更好地进行文档书写及协作。CODING Wiki 支持 Markdown 格式、版本控制、新旧版本对比、无限层级拓展等功能,同时还可以通过公开分享链接,达到让非项目成员阅读访问 Wiki 的效果。

单篇 Wiki 文档字数限制在 50,000 字以内。如果您有更高的字数需求欢迎与我们联系。

产品功能权限

  1. 访问 Wiki 、编辑 Wiki 、删除 Wiki 、分享 Wiki 四项权限需由项目管理员开启。项目管理员可以在【项目设置】->【项目与成员】->【用户组】中设置具备 Wiki 模块操作权限的用户组,并将相应的用户添加至该用户组中。

  1. 仅 Wiki 创建者及项目管理员拥有删除 Wiki 的权限。

创建&编辑 Wiki

  1. 首次使用 Wiki,在任一项目中点击【文件管理】->【Wiki】进入欢迎页,点击【创建第一个页面】。

  1. 在创建页面,可对标题和内容进行编辑。

对于已有的页面,点击【编辑文档】即可进入编辑模式。

开启实时预览

点击全屏按钮,即可进入实时预览的编辑模式。

MD 语法支持

  1. CODING Wiki 支持 MD 语法,您可以在 Wiki 编辑页面点击问号按钮,查看具体的 MD 语法。

  1. CODING Wiki 也支持 mermaid 语法。

更多 mermaid 语法,您可以查看 mermaid 官方帮助文档

Wiki 目录

  1. 选中任意 Wiki ,在左侧的工作区中选择想要修改的文档,选择【新建子页面】选项,在新页面输入标题和正文后即可完成子页面的创建。

  1. Wiki 支持无限层级目录,可拖动任意一层目录,以改变目录的顺序及层级。将文档拖拽至回收站后最多保留 30 天,之后将永久删除。

  2. 随着项目知识沉淀,目录树逐渐庞杂时,可以通过快捷操作按钮对目录树进行全部展开/全部收起操作,在右侧下拉菜单中还提供了更多展开选项。同时您还可以根据文档数量为每个项目设置合适的默认展开偏好,每次打开文档管理 时目录树会按指定方式显示。

  1. 通过拉拽目录树的分割线还可以调整目录宽度,系统会记住您的调整结果以方便下次访问。

Wiki 分享

  1. 点击需要分享的 Wiki 文档,在 Wiki 详情页面点击【分享】按钮。

  1. 开启分享按钮,即可获得此 Wiki 的分享链接。您可以选择公开或加密链接,并且还可以选择是否将子页面一起分享。需要注意的是,如果主页面已选择将子页面分享,则无论子页面是否设置了分享,都会跟随主页面的分享状态。

Wiki 历史版本

  1. 在 Wiki 详情页面点击右上方的菜单按钮,即可查看 Wiki 历史版本。

  1. 选择任一的 Wiki 历史版本,点选相应的功能菜单即可实现对应的操作。

Wiki 回收站

  1. 您可以拖拽不需要的 Wiki 至回收站完成删除操作。需要注意的是,在回收站的文件将保留 30 天,随后将会永久删除,请审慎进行该项操作。

  1. 将会通过列表视图展示回收站的文档。如果删除的 Wiki 中包含子文档,则仅会在回收站中显示主目录文档。

Wiki 访问设置

您可以为不同的文档选择不同的访问设置,文档访问提供「默认」、「项目内可见」、「只读」、「隐藏」四种访问设置,以实现对文档访问的控制。不同的设置状态将会用不同的状态图标进行显示。

默认情况下仅文档维护者和项目管理员可修改文档的访问设置,这里的文档维护者默认为文档创建者。在「只读」和「隐藏」选项中,文档的当前维护者和项目管理员可以修改文档维护者名单。若需要赋予其他成员编辑权限,请访问产品功能权限

子文档默认继承父文档的访问权限;对父文档进行带子文档分享、删除至回收站操作时,需要具有所有子文档的相应操作权限;访问权限为在成员现有 Wiki 操作权限的基础上进一步对特定文档的操作权限加以限制,以两个场景举例说明权限控制:

  1. 将一篇文档设置为对一名具备编辑权限的项目成员为只读状态,则该成员不可编辑当前文档。
  2. 将一名不具备编辑权限的项目成员列为文档维护者,则该成员依然不能编辑该文档。

若勾选「保存并应用到子文档」,则所有子文档的权限都会继承父文档的权限设置。

默认

访问设置为「默认」的文档会跟随父文档的设置,若该文档为一级文档,则与「项目内可见」设置的效果相一致,即对所有具有 Wiki 访问权限的项目成员可见;并且具备 Wiki 操作权限的项目成员都可以进行相应的操作。

项目内可见

对该项目内所有具备 Wiki 访问权限的成员可见。

只读

对具备 Wiki 访问权限的项目成员为只读,在此权限设置下即便是拥有 Wiki 编辑权限的项目成员也无法进行修改,仅允许文档维护者操作文档(编辑文档、更改分享设置、删除文档,或新建、操作子文档)。在权限设置页面可以设置多个维护者。

隐藏

在设置此权限后该文档仅对文档维护者和只读成员可见,仅允许文档维护者操作文档(编辑文档、更改分享设置、删除文档,或新建、操作子文档),在设置权限时可以指定文档维护者和只读成员。

上一篇制品库
文档是否对您有用?
感谢反馈有用
感谢反馈没用