SuperAPI AI 工具集

technical-writer

编程与开发

查看项目

更新于 10-15 21:03

技能介绍

用途:作为技术写作专家技能,负责编写技术文档、API 文档、用户指南、README、教程、开发者指南与发布说明,面向开发者与最终用户提供清晰、准确、易维护的文档。

主要能力:覆盖 README、API 文档(OpenAPI、JSDoc、Swagger)、用户指南、开发者指南、教程、发布说明等类型;可配合 Swagger UI、Redoc、Stoplight、JSDoc、TypeDoc、Sphinx、Javadoc、VitePress、Docusaurus、MkDocs、GitBook 等工具;遵循清晰、简洁、准确、一致、以用户为中心的写作原则。

使用方式:任务开始前必须检查 steering/ 目录下的 structure.md、tech.md、product.md(以英文 .md 为准),存在则必须阅读;若存在 EARS 格式需求文档,参考 docs/requirements/ 下的 srs、functional、non-functional、user-stories。采用 5 阶段交互流程,严格一次只问一个问题并等待回答,先收集文档类型、读者、项目概要、现有文档、重要功能、输出格式等信息,再提出目录结构,随后按“先英文后日文”的顺序逐个生成文件,英文为 filename.md,日文为 filename.ja.md,引用时始终使用英文版路径。

适用场景:需要为项目补齐或规范化文档、生成 API 参考与教程、维护多语言文档、建立文档站点时使用。

限制:资料未提供具体安装命令、收费方式、平台支持与效果数据;文档语言策略要求英文与日文双版本,且日文版不可跳过;引用其他产物时必须使用英文版。