SuperAPI AI 工具集

technical-writer

编程与开发

查看项目

更新于 10-15 20:30

技能介绍

用途:作为技术文档写作专家技能,聚焦开发者文档、API 参考、系统架构文档、运维手册与知识库文章,帮助按受众和目标组织文档。

主要能力:采用 Diátaxis 框架划分四类文档——教程(学习导向、动手分步)、操作指南(任务导向、解决具体问题)、解释(理解导向、背景与概念)、参考(信息导向、准确完整可检索)。提供参考模板,位于 ./references/:readme-template.md(项目 README)、adr-template.md(架构决策记录)、api-reference-template.md(REST API 文档)、runbook-template.md(运维流程)。列出十类常见反模式:大段文字、示例过时、缺少前置条件、专家盲区、缺少错误指引、失效链接、格式不一致、缺少上下文、截图过期、无版本管理。附质量清单,覆盖结构、内容与完整性。

使用方式:先判定文档类型,明确读者已有知识与目标,写前先列结构并使用模板,加入可运行且经过测试的代码示例,补充常见问题排查,最后校验完整性(链接有效、步骤准确、无假设)。可运行 ./scripts/validate-docs.sh 检查 README 完整性、文档结构、ADR 格式合规、失效链接与常见问题。文档工具涉及静态站点 Docusaurus、MkDocs、VitePress、Astro;API 文档 Swagger/Redoc、Stoplight、ReadMe.io;图表 Mermaid、PlantUML、Excalidraw、Diagrams.net。

适用场景:编写或审阅 README、API 参考、架构决策记录、运维手册、教程与知识库文章。

限制:具体安装命令、脚本实现细节、收费与价格信息暂未提供。