文档概览
这是一份可直接替换内容的 HTML 阅读页模板。它把标题、摘要、正文、目录和版本信息分开处理,让长文档在桌面与手机上都保持清晰的阅读节奏。
发布真实文档时,保留页面的语义结构与排版规则,再将本页示例内容替换为你的正文即可。目录锚点、打印样式与阅读进度会继续工作。
好的知识库不只是保存内容,也要让内容在需要时被迅速重新发现。
使用方式
先从读者任务出发
文档标题应直接说明读者能获得什么,摘要则补充适用场景。避免使用“杂项”“其他记录”这类只有作者自己才能理解的名称。
保持层级稳定
一篇文档使用一个一级标题;正文从二级标题开始划分章节。段落尽量保持单一主题,清单用于需要逐项执行或核对的内容。
让链接具有上下文
链接文字应说明目标,例如“查看发布检查清单”,而不是含义模糊的“点击这里”。这也能让使用读屏软件的读者更快浏览页面。
发布前检查
每次上线或更新文档前,建议至少完成以下检查:
- 页面标题和摘要能够准确概括正文。
- 所有图片都有替代文本,所有链接都能正常访问。
- 仅使用键盘也可以完成导航和主要操作。
- 在手机、平板和桌面宽度下没有横向溢出。
- 文档版本和最后更新时间已经同步。
持续维护
文档需要明确的维护责任。内容发生变化时,更新正文与版本号;如果文档不再适用,应给出归档标记和替代文档,而不是让旧链接突然失效。
对于经常被访问的文档,可以定期检查搜索词和反馈,确认标题、分类与内容是否仍然符合团队当前的使用方式。