文档管理
文档管理用于创建和维护产品帮助文档,帮助用户了解如何使用您的软件产品。
文档集合
文档按集合组织,每个集合可以包含多篇相关的文档。例如,您可以创建「快速入门」「功能指南」「常见问题」等集合。每个集合可以关联到特定产品,也可以作为通用文档不关联产品。
在文档管理页面,您可以看到所有文档集合的列表,包括集合名称、图标、关联产品、文档数量和状态。点击集合可以进入查看该集合下的所有文档。
添加文档集合
点击「添加集合」按钮创建新的文档集合,需要填写集合名称、Slug、描述、图标(支持Emoji或图标类名)和关联产品。集合创建后,可以在其中添加文档菜单和文档内容。
文档菜单
每个集合下可以创建多级文档菜单结构。菜单项可以是包含内容的文档页面,也可以是纯分类目录。通过拖拽可以调整菜单项的顺序和层级关系。
编写文档
点击有内容标记的菜单项可以编辑文档内容。文档编辑器支持富文本格式,可以添加标题、段落、列表、代码块、图片等内容。文档支持多语言版本,需要在翻译管理中为其他语言添加翻译。
