内容创作
ring:documentation-structure avatar

ring:documentation-structure

专业文档架构的标准与模式,涵盖内容层级、易读页面设计、导航策略及 AI 技术写作质量检查清单。

简介

此技能提供了一套稳健的框架,用于建构技术文档,确保内容易于访问、扫描,并根据用户任务而非内部系统架构进行逻辑组织。专为技术写作人员、软件工程师以及负责维护项目知识库、API 参考文档和用户指南的 AI 代理所设计。通过强制执行特定模式,降低用户的认知负荷并提升信息检索效率。

  • 内容层级:实现标准化的树状结构,从欢迎页面到 API 参考与更新日志。

  • 页面结构模式:定义总览、概念性文档与任务导向指南的特定模板。

  • 导航策略:提供面包屑、顺序性“上一篇/下一篇”导航以及页面内区段链接的规则。

  • 信息密度:设定易读性标准,包括列表项目、表格与关键术语加粗的准则。

  • 渐进式揭露:鼓励先放置核心信息,后续再补充进阶配置与边缘情况。

  • 质量保证:包含强制性的检查清单,以防止出现孤儿页面并确保内容相关性。

  • 交互链接策略:优化内部链接配置,避免过度链接,同时确保概念文档与 API 端点间的顺畅切换。

  • 严格依照用户心智模型与任务组织内容,而非依照系统组件。

  • 强制使用区段分隔线 (---) 来区隔主要主题并提升可读性。

  • 总览页面必须包含子内容的链接列表,以防止导航死胡同。

  • 在重组前,请先确认现有的信息架构并确保内容盘点完成。

  • 使用表格进行结构化比较,使用列表处理序列性的任务步骤。

  • 务必在代码示例引用后立即提供说明。

仓库统计

Star 数
180
Fork 数
20
Open Issue 数
7
主要语言
Python
默认分支
main
同步状态
空闲
最近同步时间
2026年4月29日 08:35
在 GitHub 查看