快速开始
这份指南帮助你开始阅读知识库,并了解维护文档的基本流程。
1. 找到需要的文档
从顶部「文档」进入文档总览,再通过左侧目录选择主题。
打开一篇文档后,可以先看标题和简介,再利用页面目录跳到需要的章节。手机上的文档导航位于左上角菜单中。
2. 按步骤阅读
操作类文档建议依次阅读「适用范围」「准备工作」「操作步骤」与「结果确认」。如果文档中的实际情况与你的环境不同,应先核实差异,再继续操作。
阅读提示
页面底部的「上一页 / 下一页」可以帮助你顺着目录继续阅读。
3. 开始维护内容
本站使用 Markdown / MDX 文件管理文档。新增和修改内容的一般流程如下:
- 在项目的
docs目录创建或编辑文档。 - 为文档设置明确的标题、简介和稳定的文件名。
- 将新文档加入站点文档列表与侧边栏。
- 在本地预览,检查文字、图片和链接。
- 生成生产版本,并将构建结果交给站点维护人员发布。
具体格式和示例见文档编写指南。
4. 确认发布效果
- 从导航可以找到新文档。
- 直接打开文档地址,页面能正常显示。
- 图片、附件和文档链接均可访问。
- 手机和桌面上的文字与表格都能正常阅读。
保持链接稳定
内容更新时,尽量保留原有文档地址。必须调整地址时,应由站点维护人员处理旧链接的跳转。