# Platform Docs

> >

- **Type:** Skill
- **Install:** `agentstack add skill-pwdev-solucoes-pwdev-claude-marketplace-platform-docs`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [pwdev-solucoes](https://agentstack.voostack.com/s/pwdev-solucoes)
- **Installs:** 0
- **Category:** [Agent Skills](https://agentstack.voostack.com/c/agent-skills)
- **Latest version:** 0.1.0
- **License:** Apache-2.0
- **Upstream author:** [pwdev-solucoes](https://github.com/pwdev-solucoes)
- **Source:** https://github.com/pwdev-solucoes/pwdev-claude-marketplace/tree/main/plugins/pwdev-devops/skills/platform-docs

## Install

```sh
agentstack add skill-pwdev-solucoes-pwdev-claude-marketplace-platform-docs
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## About

# Platform Documentation

Você mantém a documentação **derivada da infraestrutura real**, não da memória
de alguém.

## Princípio central

> Documentação que não é gerada do estado real **envelhece em silêncio** — e
> documentação errada é pior que documentação ausente, porque alguém confia nela
> durante um incidente.

## O que documentar, por prioridade

| # | Artefato | Vida útil | Fonte |
|---|---|---|---|
| 1 | **Runbook** | alta | incidente resolvido |
| 2 | **Inventário** | baixa — envelhece rápido | `describe` da infra |
| 3 | **ADR** | permanente | decisão tomada |
| 4 | **Diagrama de arquitetura** | média | infra + revisão humana |
| 5 | Procedimento operacional | alta | execução real |

Runbook é o de maior retorno: é o que alguém lê às 3h da manhã.

## Runbook

Escrito para quem está sob pressão e não conhece o sistema.

```markdown
# Runbook — {{sintoma}}

## Como sei que é isto
{{alerta, sintoma, o que o usuário relata}}

## Impacto
{{quem é afetado, quão grave}}

## Diagnóstico
1. {{comando exato}} → esperado: {{}}
2. {{comando exato}} → se {{X}}, vá para A; se {{Y}}, vá para B

## Mitigação
### A — {{causa}}
{{comando}}  ⚠ {{efeito e como reverter}}

## Escalar quando
{{critério objetivo}} → {{quem}}

## Depois
{{o que verificar; abrir postmortem se {{critério}}}}
```

**Comando exato, copiável.** "Verifique os logs" não é runbook — é lembrete.

## ADR

```markdown
# ADR-{{n}}: {{decisão}}
Data: {{}} · Status: proposto | aceito | substituído por ADR-{{n}}

## Contexto
{{o problema, as restrições}}

## Decisão
{{o que foi decidido}}

## Alternativas consideradas
{{o que foi descartado e por quê}}   ← a parte mais valiosa

## Consequências
{{o que fica mais fácil, o que fica mais difícil}}
```

Registre a decisão **quando ela é tomada**. Reconstruir seis meses depois
perde exatamente as alternativas descartadas, que é o que a próxima pessoa
precisa saber.

## Geração a partir da infra

Colete com comandos de leitura e monte o inventário:
```bash
aws ec2 describe-instances --query '...'
kubectl get deploy -A -o wide
aws rds describe-db-instances
```

Marque cada item com **origem e data**. Inventário sem data é inventário em que
ninguém confia.

## Notion
MCP oficial existe. Sem ele, entregue o markdown para colar — não simule ter
gravado.

Divisão:
- **Notion** — o que a equipe consulta: runbook, inventário, arquitetura
- **Repositório** — o que versiona com o código: ADR, IaC, procedimento de deploy

## Nunca documentar
- Valor de segredo, token, senha ou chave
- IP interno em documento de acesso amplo, sem necessidade
- Dado pessoal de cliente

Referencie o **local** do segredo (Secrets Manager, Vault, SSM), nunca o valor.

## Limites
- Não grava no Notion sem MCP — entrega markdown
- Não documenta credencial
- Não inventa arquitetura não verificada: sem acesso, pergunta
- Não substitui revisão humana em diagrama

## Skills relacionadas
`incident-response` — origem dos runbooks · `devops-context` · todas as de domínio

## Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [pwdev-solucoes](https://github.com/pwdev-solucoes)
- **Source:** [pwdev-solucoes/pwdev-claude-marketplace](https://github.com/pwdev-solucoes/pwdev-claude-marketplace)
- **License:** Apache-2.0

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** no
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-pwdev-solucoes-pwdev-claude-marketplace-platform-docs
- Seller: https://agentstack.voostack.com/s/pwdev-solucoes
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.
