---
name: doc-blueprint
description: |
  Gera blueprints de documentacao usando templates padronizados.
  Suporta README, API docs, arquitetura, e guias.
  Use quando: criar README, documentar API, gerar arquitetura.
allowed-tools:
  - Read
  - Write
  - Glob
  - Grep
user-invocable: true
---

# Documentation Blueprint Skill

## Proposito

Esta skill gera documentacao tecnica automaticamente a partir do codigo e artefatos.

## Comandos

### /doc-readme

Gera README.md baseado na analise do codigo:

```bash
/doc-readme
```

Analisa:
- Estrutura do projeto
- Arquivos de configuracao (package.json, *.csproj, etc.)
- Codigo fonte
- Dependencias

### /doc-api

Gera documentacao de API:

```bash
/doc-api
```

Extrai:
- Endpoints (controllers, routes)
- Request/Response schemas
- Codigos de erro
- Exemplos de uso

### /doc-arch

Gera documentacao de arquitetura:

```bash
/doc-arch
```

Inclui:
- Visao geral do sistema
- Diagrama de componentes (Mermaid)
- Fluxos de dados
- ADRs relacionados

### /doc-onboarding

Gera guia de onboarding para desenvolvedores:

```bash
/doc-onboarding
```

Contem:
- Setup do ambiente
- Estrutura do projeto
- Fluxo de desenvolvimento
- Convencoes de codigo

### /doc-runbook

Gera runbook operacional:

```bash
/doc-runbook
```

Inclui:
- Procedimentos de deploy
- Troubleshooting comum
- Metricas a monitorar
- Contatos de escalacao

## Templates

### README Template

```markdown
# {Project Name}

{Brief description - 2-3 sentences}

## Status

[![Build](badge-url)](link)
[![Coverage](badge-url)](link)
[![License](badge-url)](link)

## Overview

{What the project does, key features}

## Architecture

{High-level architecture diagram}

```mermaid
graph TD
    A[Client] --> B[API Gateway]
    B --> C[Service]
    C --> D[Database]
```

## Getting Started

### Prerequisites

- {requirement 1}
- {requirement 2}

### Installation

```bash
# Clone
git clone {repo-url}
cd {project}

# Install dependencies
{install-command}

# Configure
cp .env.example .env
# Edit .env with your settings

# Run
{run-command}
```

### Configuration

| Variable | Description | Default |
|----------|-------------|---------|
| `VAR_1` | Description | `default` |

## Usage

```bash
# Example usage
{example-command}
```

## API Reference

See [API Documentation](docs/api.md)

## Development

### Running Tests

```bash
{test-command}
```

### Code Style

{code-style-info}

### Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

## License

{license-info}
```

### API Documentation Template

```markdown
# API Reference

## Base URL

`https://api.example.com/v1`

## Authentication

{auth-info}

## Endpoints

### {Resource Name}

#### GET /{resource}

List all {resources}.

**Request**

```http
GET /api/v1/{resource}
Authorization: Bearer {token}
```

**Response**

```json
{
  "data": [...],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 100
  }
}
```

**Errors**

| Code | Description |
|------|-------------|
| 401 | Unauthorized |
| 500 | Internal Server Error |
```

### Architecture Document Template

```markdown
# Architecture Overview

## System Context

{High-level description}

## Components

### Component 1

- **Responsibility**: {description}
- **Technology**: {tech stack}
- **Interfaces**: {APIs, events}

### Component 2

...

## Data Flow

```mermaid
sequenceDiagram
    participant C as Client
    participant A as API
    participant S as Service
    participant D as Database

    C->>A: Request
    A->>S: Process
    S->>D: Query
    D-->>S: Result
    S-->>A: Response
    A-->>C: Response
```

## Architecture Decision Records

- [ADR-001](decisions/adr-001.yml): {title}
- [ADR-002](decisions/adr-002.yml): {title}

## Security

{security-considerations}

## Scalability

{scalability-approach}
```

## Output

Documentos sao salvos em:
`.agentic_sdlc/projects/{project-id}/docs/`

Estrutura gerada:
```
docs/
├── README.md           # Gerado por /doc-readme
├── API.md              # Gerado por /doc-api
├── ARCHITECTURE.md     # Gerado por /doc-arch
├── ONBOARDING.md       # Gerado por /doc-onboarding
├── RUNBOOK.md          # Gerado por /doc-runbook
└── diagrams/           # Diagramas gerados
    ├── architecture.mmd
    └── sequence.mmd
```

## Integracao com SDLC

| Fase | Documentacao Gerada |
|------|---------------------|
| Fase 2 | User Stories, Requisitos |
| Fase 3 | Architecture Overview, ADRs |
| Fase 5 | API Docs, Code Comments |
| Fase 7 | Release Notes, Changelog |
| Fase 8 | Runbooks, Playbooks |

## Geracao de Diagramas

Diagramas sao gerados em formato Mermaid:

```mermaid
graph TD
    subgraph "Camada de Apresentacao"
        A[Web App]
        B[Mobile App]
    end

    subgraph "Camada de API"
        C[API Gateway]
        D[Auth Service]
    end

    subgraph "Camada de Servicos"
        E[Service A]
        F[Service B]
    end

    subgraph "Camada de Dados"
        G[(Database)]
        H[(Cache)]
    end

    A --> C
    B --> C
    C --> D
    C --> E
    C --> F
    E --> G
    F --> G
    E --> H
```

## Customizacao

Para customizar templates, edite:
`.agentic_sdlc/templates/doc-*.md`

## Pontos de Pesquisa

Para melhores praticas:
- "readme best practices"
- "api documentation standards"
- "architecture documentation template"


---
Source attribution: arbgjr
Original project: https://github.com/arbgjr/satra/blob/4fbc8a20d90e5e02049e7639f5fcc0c309c6d7f4/.claude/skills/doc-blueprint/SKILL.md
License: MIT
License information: https://opensource.org/license/mit
Original upstream instructions; downloaded from Dave AI.

## Upstream license notice

MIT License

Copyright (c) [year] [fullname]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.



# Dave AI resource metadata

Creator / publisher: arbgjr
Original project: https://github.com/arbgjr/satra/blob/4fbc8a20d90e5e02049e7639f5fcc0c309c6d7f4/.claude/skills/doc-blueprint/SKILL.md
Attribution basis: Recovered original package and original project license at a pinned revision

Fields of work: Content & Media, Design, Product Management
Roles: Product Manager, Technical Writer, UX Writer
Specialties: API, Word Documents
Tools: Tool not specified
Country applicability: Country not specified
Classification basis: Source catalog labels
Instruction SHA-256: 0e01e03ba25a82adee67b7c67a79b47d27109ab9d939a2fd575ffaa02d7cbde7
Metadata reviewed: 2026-10-27
This metadata supersedes earlier Dave AI catalog attribution. Original instruction and supporting files are preserved.