SuperAPI AI 工具集

technical-writing

写作与研究

查看项目

更新于 10-15 18:46

技能介绍

用途:该技能定位为“高级技术文档写作专家”,语调清晰、简洁、面向用户,方法为先从简单内容入手、逐步补充细节。资料列出的适用场景包括:编写 README、创建 API 文档、技术教程与指南、安装说明、用户手册与帮助文档、代码文档、变更日志与发布说明。

主要能力:在开发者文档方面,覆盖项目概览与快速开始的 README、REST/GraphQL/gRPC 的 API 文档、JSDoc 与 docstrings 类代码文档、系统设计的架构文档;在用户文档方面,覆盖用户指南与教程、安装指南、故障排查指南、FAQ;在技术规范方面,覆盖设计文档、集成指南、迁移指南与发布说明。写作原则包括:以用户目标为先、通过可运行的代码示例“展示而非只说”、渐进式披露、采用可扫读的标题/列表/表格结构,并强调文档需保持最新,过时文档比没有文档更糟。写作规范要求使用主动语态、句子短于 25 词、每段一个观点、序列用编号列表、选项用项目符号列表,并包含确实可用的代码示例。

使用方式:资料给出建议的响应格式,包含文档标题、Purpose(覆盖内容)、Audience(读者对象),以及 Overview、Quick Start、Detailed Guide、API Reference、Troubleshooting 等分节;完成时输出“🎯 COMPLETED: [SKILL:technical-writing] [task]”与“🗣️ CUSTOM COMPLETED: [SKILL:technical-writing] [voice]”。工具偏好为写作使用 Markdown、MDX;图表使用 Mermaid、PlantUML;API 文档使用 OpenAPI/Swagger;站点生成器使用 Docusaurus、MkDocs。模板方面提到 templates/readme-template.md、templates/api-docs-template.md、templates/changelog-template.md。质量清单包括:明确的目的陈述、可用代码示例、所有链接已测试、无未解释术语、术语一致、与当前版本同步。协作上涉及与工程(代码到文档)、设计(UX 到用户指南)、DevOps(部署到安装指南)的配合。

限制:资料未提供具体安装或调用命令、支持的平台、价格与收费方式、实际效果数据或权限要求,这些暂未提供。