Docs

分类: 文档与知识管理 | 上传者: rsts-dev | 下载: 0 | 版本: v1.0（最新）

使用特定于基础的模板、架构图和 API 参考，通过代码库分析生成全面的技术文档。 USE WHEN 文档、文档、技术文档、API 文档、生成文档、文档代码库、创建文档。

更新日志: Source: GitHub https://github.com/rsts-dev/claude-buddy-marketplace

目录结构

当前层级: tree/main/plugins/buddy/skills/Docs/

📁 Templates/
- 📄 DefaultDocs.md 978 B
📁 Workflows/
- 📄 GenerateDocs.md 4.2 KB
📄 SKILL.md 1.5 KB

SKILL.md

---
name: Docs
description: Generate comprehensive technical documentation from codebase analysis with foundation-specific templates, architecture diagrams, and API references. USE WHEN docs, documentation, technical docs, API documentation, generate docs, document codebase, create documentation.
---

# Docs

Generate comprehensive technical documentation by analyzing the codebase with foundation-specific templates.

## Customization

**Before executing, check for user customizations at:**
`~/.claude/PAI/USER/SKILLCUSTOMIZATIONS/Docs/`

If this directory exists, load and apply any PREFERENCES.md configurations. If not, proceed with defaults.

## Prerequisites

1. PAI must be installed. Check `~/.buddy/.pai-version`.
2. Foundation must exist at `/directive/foundation.md`.

## Workflow Routing

| Workflow | Trigger | File |
|----------|---------|------|
| **GenerateDocs** | Any invocation | `Workflows/GenerateDocs.md` |

## Template Selection

Based on foundation type:
- **Default**: `Templates/DefaultDocs.md`
- **JHipster**: `Templates/JHipsterDocs.md`
- **MuleSoft**: `Templates/MuleSoftDocs.md`

## Output

Documentation is generated in the `docs/` directory with a navigation index at `docs/README.md`.

## Examples

**Example 1: Generate documentation**
```
User: "/buddy:docs"
-> Verifies foundation exists, extracts type
-> Analyzes codebase (structure, APIs, models, configs)
-> Loads DefaultDocs.md template
-> Generates: architecture.md, api-reference.md, setup.md, deployment.md
-> Creates docs/README.md as navigation index
```

登录后下载/点赞/收藏 ❤ 8 | ★ 0

Docs

目录结构

SKILL.md

举报内容

提示