SuperAPI AI 工具集

project-documentation

写作与研究

查看项目

更新于 10-15 21:08

技能介绍

用途:为任意软件项目或仓库创建并维护高质量技术文档,覆盖 README、TODO、DESIGN、架构与走查、测试、部署以及 conductor 文档。当用户要求创建或审阅文档,或新增、修改、删除功能,或改动测试、部署时触发。

主要能力:跨文档同步核心属性(如项目 ID、URL、文件路径);先读取现有文档与 conductor/tech-stack.md 了解现状;核对代码库、配置(config.py、Makefile、*.tfvars、pyproject.toml)、环境变量名与命令参数,不假设旧文档准确;对未知设计选择与缺失理由主动提问。

使用方式:创建新文档时使用 references/ 下的模板,参考 references/samples/ 的风格与结构。每次代码或功能变更后,须逐一评估各核心文档是否需要创建或更新,不需要更新的要明确说明;确保 README.md 与 testing.md 中的命令片段与最新代码行为一致。若存在 technical-writer 技能则必须配合使用;若缺失,可用 npx skills list 与 npx skills ls -g 检查,并可用 npx skills add https://github.com/shubhamsaboo/awesome-llm-apps --skill technical-writer -g -y 安装。

适用场景:新增顶层目录、核心功能、make 目标或本地开发流程变化时更新 README;完成步骤或讨论未来任务时维护 TODO(仅当文件已存在);实现 UI 框架或改动组件、样式时更新 DESIGN;新增设计决策、数据库模式、编排逻辑、基础设施或安全组件时更新架构文档;增删测试、改 mock 策略或引入质量门禁时更新测试文档;改动 Terraform、部署脚本、IAM、CI/CD 时更新部署文档;技术栈或品牌重大变化时更新 conductor 文档(仅当已存在)。

限制:TODO 与 conductor 文档仅在已存在时维护;部署文档缺失时可建议创建。文档格式建议用表格映射配置与设计决策,标题后留空行,代码用带语言标识的围栏代码块。具体模板内容与示例细节暂未提供。