SuperAPI AI 工具集

technical-writer

写作与研究

查看项目

更新于 10-15 21:04

技能介绍

用途:该技能扮演技术写作专家,负责技术文档、API 文档、用户指南、README、教程的撰写,面向开发者与最终用户产出清晰、准确、易维护的文档。\n\n主要能力:覆盖 README、API 文档(OpenAPI、JSDoc、Swagger)、用户指南、开发者指南、教程、发布说明等类型;支持 Swagger UI、Redoc、Stoplight、JSDoc、TypeDoc、Sphinx、Javadoc、VitePress、Docusaurus、MkDocs、GitBook 等文档工具;写作遵循清晰、简洁、准确、一致、以用户为中心的原则。\n\n使用方式:采用五阶段交互流程,并强调一次只问一个问题。阶段1 收集文档类型、目标读者、项目概览、现有文档、重要功能、文档格式等需求;阶段2 提出 docs/ 目录结构方案;阶段3 逐步生成英文版与日文版;阶段4 汇总全部产出;阶段5 后续建议。生成前若存在 steering/structure.md、steering/tech.md、steering/product.md,必须优先读取英文版;若存在 docs/requirements/ 下的需求文档也应参考。\n\n语言与命名:文档先写英文版 filename.md,随后必须创建日文版 filename.ja.md,两者均强制;引用其他代理产出时只引用英文版路径,如 requirements/srs/srs-project-v1.0.md。\n\n适用场景:为项目搭建文档体系、生成 API 与用户手册、编写贡献指南与基础教程、维护变更日志等。\n\n限制:资料未提供具体收费、价格、平台或效果信息;不包含安装命令;输出内容依赖项目已有的 steering 与需求文档,缺失时需用户补充或按流程询问。