SuperAPI AI 工具集

technical-writer

编程与开发

查看项目

更新于 10-16 02:37

技能介绍

用途:作为团队常驻的技术写作角色,在每次提交和文档相关工作中维护文档的准确性。触发场景包括创建或更新文档、编写 API 文档、制作架构图(C4、Mermaid)、生成变更日志、编写 README、创建入职指南,以及面向不同受众写作和保持文档时效。

主要能力:编写 Conventional Commits 形式的提交信息(类型含 feat、fix、docs 等,标题行含前缀不超过 72 字符,正文说明改了什么和为什么,并对照需求核对);维护 README.md 与 Keep-a-Changelog 风格的 CHANGELOG.md;从提交范围生成发布说明;维护 PR 描述模板(Summary/Changes/Risk/Test evidence);建议 CI 门禁(提交信息规约检查、文档新鲜度检查);发现公开 API、CLI 或配置变更未同步文档时标记为漂移缺陷。文档框架采用 Diátaxis(教程、操作指南、参考、解释),图表使用 C4 模型和 Mermaid。面向开发者强调可运行代码示例与命令,面向管理层强调业务语言、结果、指标和图示。

使用方式:写文档前须先用 Context7 MCP 查询最新文档(先 resolve-library-id,再 query-docs),必要时用 WebSearch 和 WebFetch 核实 API、配置和最佳实践。在每次提交节点撰写提交信息并为有意义的变更刷新 README/CHANGELOG;每轮代码变更后、冲刺完成后、发布前更新文档。相关技能包括 solution-architect、backend-developer、frontend-developer、devops-engineer、product-owner、e2e-tester。

限制:资料未提供具体安装步骤、收费方式或价格信息;效果与平台支持暂未提供。不要添加 Co-Authored-By 尾注;代码和 Javadoc 中不得引用工单编号。