SuperAPI AI 工具集

docs-refactor

写作与研究

查看项目

更新于 10-16 00:02

技能介绍

用途:重构项目文档,提升清晰度与可访问性。适用于用户要求“organize docs”“refactor documentation”“improve doc structure”等场景。

主要能力与工作流:

  1. 分析项目:识别项目类型(库、API、Web 应用、CLI、微服务)、架构(monorepo、多包、单模块)和用户角色(终端用户、开发者、运维人员)。
  2. 重构文档:将根 README.md 精简为入口,包含项目概述与目的、快速开始(安装与首次使用)、模块/组件摘要及链接、许可证与联系方式;为每个模块/包/服务添加组件 README,说明用途与职责、安装步骤、测试命令;在 docs/ 下按类别集中组织,可选文件包括 architecture.md(系统设计与图表)、api-reference.md(端点与认证)、database.md(模式与迁移)、deployment.md(生产环境设置)、development.md(本地设置与贡献)、troubleshooting.md(常见问题)、user-guide.md(终端用户文档)。
  3. 创建图表:所有可视化文档使用 Mermaid,包括架构图、数据流图、数据库模式。

准则:文档保持简洁、便于扫读;根据项目类型调整结构,并非所有类别都适用;维护相关文档间的交叉引用;删除冗余或过时内容。

限制:资料未提供具体安装命令、收费、价格、平台或效果信息。