SuperAPI AI 工具集

markdown-doc

编程与开发

查看项目

更新于 10-15 23:45

技能介绍

用途:面向技术文档写作场景,帮助用户产出结构清晰、对新手友好的 README、API 文档、架构设计文档、部署/运维文档、Changelog、贡献指南和用户手册,也支持优化现有文档。

主要能力:按文档类型提供结构模板;遵循 Markdown 写作规范(标题层级不超过 4 级、代码块标明语言、列表统一用 -、表格组织配置项、用 > Note 标注提示);内容上要求句子简短、主动语态、术语首次出现时解释、步骤用有序列表、配置项用表格列出。支持修改与迭代,如加章节、精简内容、补充示例、中英互译、生成目录。

使用方式:先确认项目简介、文档类型、目标读者、技术栈与功能/API 列表、是否已有文档;若信息不全则直接撰写并留占位符。随后按类型选择模板撰写并输出。

适用场景:开源项目 README、接口文档、系统架构说明、版本变更记录、部署说明、贡献指引等。

限制:不能从代码自动生成 API 文档(需 JSDoc/Swagger 等工具),不负责文档网站搭建(Docusaurus、VitePress 等),不绘制 UML 与流程图,不做项目管理排期,也不提供文档翻译的专业审校。超出范围时先完成当前写作,再说明能力边界。