mcpField
C
codebase-documenter

codebase-documenter

github.com/mhattingpete开发689591 次安装14 周前更新
代码仓库

关于 codebase-documenter

codebase-documenter 是为代码库生成开发文档的技能，涵盖架构、组件、配置和部署。它指导代码库探索，可输出多份 Markdown 文档或一份综合文档。

主要功能

  1. 01架构与数据流文档
  2. 02目录及组件说明
  3. 03配置与开发指南
  4. 04部署与贡献章节
  5. 05Mermaid 图表和代码示例
  6. 06快速、标准和深入覆盖

适用场景

  1. 01准备入职文档
  2. 02解释陌生代码库
  3. 03记录架构与数据流
  4. 04编写开发和部署指南

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/mhattingpete/claude-skills-marketplace --skill codebase-documenter

安装后在 Claude Code 中输入/codebase-documenter确认已加载。

详细介绍

代码库文档生成器

为代码库生成全面的文档，涵盖架构、组件、数据流和开发指南。

适用场景

  • “解释此代码库”
  • “编写架构文档”
  • “这段代码是如何工作的”
  • “创建开发者文档”
  • “生成代码库概览”
  • “创建入门文档”

文档内容

1. 项目概览
  • 目标与愿景
  • 目标用户
  • 主要功能
  • 技术栈
  • 项目状态
2. 架构
  • 高层结构
  • 设计模式
  • 数据流
  • 控制流
  • 图表（Mermaid）
  • 架构决策
3. 目录结构
  • 目录组织目的
  • 命名约定
  • 入口点
  • 核心模块
  • 配置文件位置
4. 关键组件
  • 主要模块
  • 类与函数
  • 职责
  • 交互方式
  • 扩展点
  • 代码示例
5. 外部集成
  • 使用的 API
  • 数据库与架构
  • 身份验证
  • 缓存
  • 消息队列
  • 文件存储
6. 数据模型
  • 数据库架构
  • 数据结构
  • 验证
  • 迁移
  • 数据转换
7. 开发环境设置
  • 先决条件
  • 安装步骤
  • 配置
  • 运行应用
  • 测试
  • 调试
  • 故障排除
8. 开发指南
  • 编码约定
  • 测试方法
  • 错误处理
  • 日志记录
  • 安全实践
  • 性能模式
9. 部署
  • 构建流程
  • 部署步骤
  • 环境
  • 监控
  • 回滚流程
10. 贡献
  • 开发工作流
  • 代码审查指南
  • 测试要求
  • 文档更新

方法

  1. 使用 Explore Agent 进行探索（全面细致）
  2. 使用 Glob 绘制结构图
  3. 阅读关键文件（README、入口点、核心模块）
  4. 使用 Grep 识别模式（导入、导出）
  5. 跟踪执行路径
  6. 从文档、注释和测试中提取知识
  7. 综合整理，形成连贯的文档

输出

创建 Markdown 文档：

docs/
├── README.md              # Overview and quick start
├── ARCHITECTURE.md        # System architecture
├── DEVELOPMENT.md         # Development guide
├── API.md                 # API documentation
├── DEPLOYMENT.md          # Deployment guide
└── CONTRIBUTING.md        # Contribution guidelines

也可以根据需要创建一份综合文档。

深度级别

  • 快速：高层概览（15-30 分钟）
  • 标准：全面覆盖（30-60 分钟）
  • 深入：详尽内容并包含示例（60 分钟以上）

可视化元素

  • Mermaid 图表（架构图、流程图、时序图）
  • 来自代码库的代码示例
  • 具体的文件:行号引用
  • 用表格呈现结构化信息
  • 用列表呈现指南

使用的工具

  • Task（Explore Agent）：探索代码库
  • Glob：绘制目录结构
  • Grep：查找模式、导入和导出
  • Read：分析关键文件
  • Write：创建文档
  • Bash：提取元数据（git log、版本）

成功标准

  • 全面覆盖所有领域
  • 解释清晰并附有示例
  • 复杂概念配有可视化图表
  • 提供具体的文件:行号引用
  • 提供可执行的设置与开发说明
  • 新开发者只依靠文档即可完成入门
  • 结构清晰，便于浏览
  • 信息准确且及时更新

集成

  • code-auditor：包含质量与安全背景信息
  • project-bootstrapper：记录引导决策
  • visual-html-creator：创建可视化图表

评论

支持 Markdown