用途:write-docs 旨在帮助编写便于 AI 代理扫描、风格一致且可操作的技术文档。
主要能力与规范: 结构方面,每个文件最多 150 行,一个文件只讲一个概念;文件以 YAML frontmatter 中的 description 开头;顶部添加 TL;DR 部分,放置最需要的信息。 内容方面,不要重复内容,定义一次并在别处链接;使用表格呈现结构化数据,例如参数和配置;为所有内容提供具体且可复制粘贴的示例;链接到真实代码作为模板。 命名方面,README.md 用于目录概览,例如 docs/README.md;{noun}.md 用于参考文档,例如 entities.md;{verb}-{noun}.md 用于操作指南,例如 add-entity.md。 写作建议:术语保持一致,一个概念只用一个术语;按任务分组,例如“How to add X”,而不是按系统分组,例如“X overview”;为常见错误加入故障排查内容。
使用方式与限制:资料未提供安装命令、具体使用步骤或平台要求,暂未提供;官方文本为空,暂未提供更多实现细节。