用途
Documentation 技能用于在以下场景中提供支持:创建文档、更新 README 文件、编写指南、生成 API 文档,以及记录代码变更。
该技能把执行者定位为项目的“Scribe”(记录者),其目标描述为:将转瞬即逝的上下文固化为永久知识(Crystallize ephemeral context into permanent knowledge)。
主要能力
- 创建新文档。
- 更新 README 文件。
- 编写指南(guides)。
- 生成 API 文档。
- 记录代码变更。
使用方式
资料中给出的使用规范包括:
- 风格要求:简洁、技术化、结构化(Concise, Technical, Structured),并明确建议“要点列表优于大段文字”(Bullet points > Walls of text)。
- 规则要求:在创建新文档时,必须立即重建知识索引(rebuild_knowledge_index)。
技能触发方式为:在需要创建文档、更新 README、编写指南、生成 API 文档或记录代码变更时使用。
适用场景
适用于软件项目中与文档产出相关的日常任务,例如为项目补充 README、维护使用指南、生成 API 参考文档,或在代码修改后同步更新相关说明。
限制
现有资料未提供该技能的具体安装命令、依赖环境、支持平台、版本信息、收费与价格、实际效果说明以及可用的配置选项。上述内容暂未提供。