Skip to content
Back to skills

C2f Documentation Governance

ASecurity

LEIA ANTES de escrever ou atualizar documentações técnicas, especificações e manuais. Se não ler: documentação diverge do código-fonte real (Princípio da Autoridade do Código) e gera alucinações em agentes futuros.

  • 4 stars
  • 0 votes
  • 0 copies
  • 0 views
  • Added November 7, 2026
developmentgophpbashsqlexpressgitapidocumentation

Works with

  • api

Security analysis

A100/100

Scanned November 7, 2026

npx -y skills add otavioserra/conn2flow-ai-workspace --skill c2f-documentation-governance --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of C2f Documentation Governance?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for C2f Documentation Governance
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/otavioserra-c2f-documentation-governance/badge)](https://www.skillsdirectory.com/skills/otavioserra-c2f-documentation-governance)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: c2f-documentation-governance
description: "LEIA ANTES de escrever ou atualizar documentações técnicas, especificações e manuais. Se não ler: documentação diverge do código-fonte real (Princípio da Autoridade do Código) e gera alucinações em agentes futuros."
user-invocable: false
---

# Governança e Verificação de Documentação (`c2f-documentation-governance`)

# ⚡ Gatilho Obrigatório
- **TRIGGER**: Criar, atualizar ou validar qualquer documento técnico em `docs/`, `sdd/` ou guias de arquitetura.
- **SKIP APENAS SE**: Correção de pequenos erros de digitação (typos) em arquivos que não alterem contratos normativos.
- **CONSEQUÊNCIA DE IGNORAR**: Doc drift (documentação desatualizada), propagação de premissas falsas e violação do Princípio da Autoridade do Código-Fonte.

---

Consulte e aplique este protocolo de verificação para garantir a sincronia e autoridade do código em relação a documentações técnicas:

## 1. Princípio da Autoridade do Código-Fonte

* **Documentações (`docs/`, `*.md`)**: Expressam a intenção arquitetural, histórico e manuais de uso.
* **Código-Fonte (`gestor/`, `modulos/`, `scripts/`, `db/`)**: É a **Fonte Suprema da Verdade**.
* **Regra de Ouro**: NUNCA assuma que assinaturas de função, caminhos de arquivo, parâmetros de API ou estruturas de tabela em documentações estão 100% atualizados sem antes inspecionar o código PHP/JS/SQL autoritativo correspondente via `view_file` ou `grep_search`.

---

## 2. Protocolo de Auditoria e Verificação

Sempre que utilizar uma documentação para orientar uma implementação ou criar uma Skill:
1. **Verificação de Caminho**: Confirme se os arquivos de controladores, bibliotecas ou scripts citados realmente existem no disco.
2. **Verificação de Assinatura**: Abra o arquivo `.php` / `.js` real e verifique o nome exato da função, ordem dos argumentos e tipos de retorno.
3. **Verificação de Metadados de Banco**: Consulte os arquivos de migração Phinx (`gestor/db/migrations/`) e manifestos `schema-metadata.json` para validar a existência de tabelas e colunas.
4. **Resolução de Divergências**: Se houver divergência entre a documentação e o código-fonte real, **o código-fonte prevalece**, devendo a documentação ser corrigida.

---

## 3. Manutenção da Documentação em Tarefas SDD

- Ao adicionar novos parâmetros, funções centrais, hooks ou rotas, atualize a documentação correspondente sob `ai-workspace/` ou `sdd/`.
- Registre depreciações ou quebras de contrato no log do lote (`batch-XXX.md`) e atualize os guias técnicos afetados.

---

## 4. Fluxo Mandatório Pós-Alteração de Código (`docs:audit`)

Modificar qualquer arquivo de código listado no cabeçalho `sources:` de um documento técnico normativo invalida o campo `verified_at`, gerando avisos de fonte divergente no ecossistema.

### 4.1 Sequência de 5 Etapas do Executor

Após concluir alterações em código que afetam contratos públicos ou bibliotecas documentadas:

1. **Auditar Fontes Afetadas**:
   ```bash
   ./c2f docs:audit
   ```
   *Lista todas as documentações cujas fontes de código declaradas foram modificadas.*

2. **Sincronizar Conteúdo Textual**:
   Atualizar o corpo das documentações que descrevem os comportamentos, parâmetros ou retornos alterados.

3. **Atualizar Metadado `verified_at`**:
   Atualizar o campo `verified_at:` no frontmatter do documento com o commit hash mais recente correspondente ao código verificado.

4. **Extrair Novas Funções (se aplicável)**:
   Se novas funções foram introduzidas em bibliotecas ou controladores:
   ```bash
   ./c2f docs:extract <biblioteca>
   ```

5. **Compilar Documentação para Publicação**:
   Reconstruir os manifests e HTML das documentações do projeto:
   ```bash
   ./c2f docs:build --project=<id>
   ```

> [!IMPORTANT]
> Nunca altere assinaturas de funções públicas ou tabelas de banco sem rodar `c2f docs:audit`. Documentações com `verified_at` obsoleto induzem outros agentes a erro por alucinação baseada em contratos antigos.

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.