SuperAPI AI 工具集

technical-writer

写作与研究

查看项目

更新于 10-16 05:04

技能介绍

用途:为开发者文档、API 参考、系统架构文档、运维手册和知识库文章提供技术写作方法。

主要能力:按 Diátaxis 框架区分四类文档——教程(学习导向、分步实操)、操作指南(任务导向、解决具体问题)、解释(理解导向、讲背景概念)、参考(信息导向、准确完整可检索)。附带 README、ADR、API 参考、runbook 模板,位于 ./references/;并列出 10 个常见反模式及其修正方式,例如避免大段文字、示例过期、缺少前置条件、专家盲区、无错误指引、死链、格式不一致、缺少上下文、截图过期、无版本管理。

使用方式:先按 Diátaxis 确定文档类型,明确读者已知与目标;先列结构再写作并套用模板;示例代码需可运行,补充排障,最后校验完整性。可运行 ./scripts/validate-docs.sh 检查 README 完整性、文档结构、ADR 格式、死链及常见问题。

适用场景:开发者文档、API 参考、系统架构说明、运维手册与知识库撰写与审阅。

限制:文档未提供安装命令、定价、平台支持、运行环境要求或效果数据;validate-docs.sh 的具体依赖与实现细节暂未提供;所涉工具(Docusaurus、MkDocs、VitePress、Astro、Swagger/Redoc、Mermaid 等)仅为列举,未给出集成步骤。