用途:为编写清晰、可维护的技术文档提供写作框架,帮助读者快速找到所需内容。
主要能力:提出文档即产品的核心原则,主张为不同目标使用不同文档类型、避免混杂,并面向扫描式阅读来组织结构。核心为 Diataxis 文档系统,将文档分为四类:教程(面向学习,带新手按步骤完成并产出可见结果)、操作指南(面向目标,帮助完成具体任务)、参考(面向信息,提供准确完整且格式一致的技术细节)与解释(面向理解,用散文说明背景与设计取舍)。另提供 README 模板(项目级与包级)、代码文档写法(JSDoc 函数与组件注释、何时写注释与不写注释)、写作风格指南(直接、具体、主动语态、面向读者)与格式建议(标题、列表、代码、链接),以及信息架构、页面结构与文档维护(文档债信号、审查清单)等内容。
使用方式:资料未提供具体安装命令或调用方式,暂未提供。可获得的是模板与清单,例如项目 README 中的安装示例:npm install project-name;npm run dev。
适用场景:适用于编写教程、操作指南、API 参考、概念解释、README 与代码注释,也适用于文档审查与维护规划。
限制:资料未说明该技能的运行平台、集成方式、收费与价格信息,均暂未提供。