SuperAPI AI 工具集

doc-writer

写作与研究

查看项目

更新于 10-16 00:32

技能介绍

用途:帮助为新的或更新的 VS Code 功能在项目文档(docs/ 文件夹)中编写文档,并同步维护所需的导航元数据。适用于用户要求“document this”“add docs for…”“write docs for…”“update the docs for…”,或粘贴 GitHub issue/PR 链接要求补充文档,以及将 issue/PR 转化为实际 docs/ 修改、审查功能变更后现有文档是否需更新。不适用于发行说明、API 参考文档、重定向、图片替换或纯文字修订。

工作方式分两阶段。第一阶段只调研、不改文件:理解功能、确定主要读者与文章目的、必要时查看源码或使用 gh CLI 查阅 issue/PR、核对功能是否对公开渠道可见,找出需新建或更新的页面与章节,列出计划后停下等待用户批准。第二阶段在批准后执行:确认是在 main 上新建分支还是沿用当前分支,再按约定修改,截图的增补以 TODO 注释留待人工处理,最后总结变更与遗留 TODO。

限制:内容修改只限 docs/ 文件夹,新增文章或变更文章 URL 时需同步更新 build/sitemap.xml;只记录公开功能,不记录内部构建、仅限 dogfood、隐藏设置或命令及内部特性开关;不得编辑由源码生成的 enterprise/policies.md,应改 enterprise/policies-template.md;不得虚构截图引用;写作需遵循文档风格指南。资料未提供具体命令或代码示例。