SuperAPI AI 工具集

technical-writer

写作与研究

查看项目

更新于 10-16 05:42

技能介绍

用途:该技能面向技术文档的撰写与改进,调用场景为编写或完善文档,包括 README、API 文档(OpenAPI/Swagger)、架构决策记录(ADR)等。

主要能力:提供 README 模板、架构决策记录模板、运行手册模板、OpenAPI/Swagger 示例、Keep a Changelog 格式更新日志、事后复盘模板、JSDoc/TSDoc 参考以及文档检查清单。其核心原则是:以受众为先、便于扫读、内容准确、简洁、可操作。

使用方式:在需要编写或改进文档时调用该技能。运行手册中的诊断命令与部署命令保持原样,例如:curl https://api.example.com/health;psql $DATABASE_URL -c "SELECT count(*) FROM pg_stat_activity;";git log --oneline -10;kubectl rollout restart deployment/api-server;kubectl rollout status deployment/api-server;git revert HEAD;gh workflow run deploy.yml;kubectl scale deployment/api-server --replicas=5。

适用场景:为工程团队编写面向开发者的文档,包括项目入口说明、接口参考、架构决策记录、事故运行手册、版本变更记录与事后复盘。

限制:资料未说明具体收费、价格、平台支持范围或效果保证;文档模板与命令示例需结合具体项目实际内容使用,不应直接照搬。