SuperAPI AI 工具集

technical-writing

写作与研究

查看项目

更新于 10-15 20:33

技能介绍

用途:该技能用于撰写专业的技术文档,涵盖 API 文档(REST、GraphQL、webhook、认证)、用户指南(功能、操作步骤、故障排查)、教程(含动手示例)、架构文档(系统设计与技术决策)、README(项目概览与快速开始)、发布说明(变更、迁移、破坏性变更)以及技术规格(需求与约束)。

主要能力:提供文档类型识别、上下文收集、内容结构组织、清晰写作、代码示例编写与质量校验的完整工作流。写作原则包括使用主动语态、具体量化描述、首次出现时定义缩写、术语一致、祈使句指令、为每个概念提供示例。代码示例要求标注语言、完整可运行、含输入输出对、复杂逻辑加注释并在发布前测试。

使用方式:先确定文档类型,再收集受众、技术深度、范围、标准与相关文档等上下文,然后按概述先行、标题层级(H1→H2→H3)、超过三节加目录、示例紧随概念、复杂流程配图的方式组织内容,最后按质量清单校验准确性、完整性、清晰度、示例、结构、一致性、链接、语法与时效性。资料提到可加载 documentation-types-and-workflows.md 获取模板与模式,加载 writing-guidelines.md 获取详细风格规则。

适用场景:项目 README、版本发布说明、API 参考、用户手册、学习教程、架构决策记录与技术规格等。

限制:资料未提供具体安装命令、平台支持、收费方式或实际效果数据;文档模板与风格指南文件的具体内容暂未提供。