project-documentation

仓库创建 2026年1月5日最近提交 1 天前SkillHot 收录 20 天前

▸ 精选理由

自动产出带图示的文档，能显著减少新人成长成本

▸ 风险提示

会扫描源码与依赖，可能暴露敏感信息

这个 Skill 做什么

扫描源码与结构，生成全面项目文档与架构图

扫描代码树提取组件、接口和依赖，生成全面的项目文档、上下文说明和 Mermaid 架构图，既有入门级别的项目概览也有深度模块说明。适合新同事入职、整理零散知识或产出项目交付文档时使用。亮点是把源码结构和文档结合，既能快速上手也方便做后续深挖。

办公文档项目文档Mermaid源码分析入职通用

1.6k

Stars

Forks

仓库内 Skill

+111

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/a5c-ai/babysitter/main/library/methodologies/bmad-method/skills/project-documentation/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/a5c-ai/babysitter/main/library/methodologies/bmad-method/skills/project-documentation/SKILL.md"

SKILL.MD 节选查看完整文件 ↗

# Project Documentation

Generate comprehensive project documentation with source tree analysis and Mermaid diagrams.

## Agent
Paige (Tech Writer) - `bmad-writer-paige`

## Workflow
1. Scan project structure and identify components
2. Analyze source tree with annotations
3. Generate project context for onboarding
4. Create deep-dive component documentation
5. Generate Mermaid architecture diagrams
6. Build documentation index with navigation

## Inputs
- `projectName` - Project name
- `projectPath` - Path to project root
- `documentationType` - full-scan, deep-dive, or context-only

## Outputs
- Scan report with component inventory
- Annotated source tree
- Project overview and onboarding g

via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有