Pular para o conteúdo
Skillpedia
Documentação280 mil · #49

docs-governance

Ajuda seu agente a gerenciar e organizar a documentação de projetos. Ele pode auditar papéis, links e referências, garantindo a integridade e organização do conhecimento.

O que ela faz

Este agente ajuda a organizar e verificar a documentação de um projeto. Ele direciona pedidos sobre governança de documentação para as ferramentas certas e pode fazer uma auditoria para ver se os links e informações estão corretos.

Quando usar

  • ✓Quando você não sabe qual ferramenta usar para organizar a documentação.
  • ✓Se você precisa verificar se os links e documentos importantes do projeto estão corretos.
  • ✓Para entender quem é responsável por cada parte da documentação.

Exemplo do que pedir para a IA

“Verifique se a documentação do meu projeto está organizada e se todos os links funcionam.”

Quer saber mais? Abra as seções abaixo.

Como usar

O jeito mais fácil: copie a mensagem abaixo e cole no Claude, ChatGPT, Cursor ou outra IA. Ela lê a skill e segue as instruções.

Link da skill

https://github.com/affaan-m/ECC/blob/main/pi/core/skills/docs-governance/SKILL.md

Mensagem pronta para colar

Use esta skill para me ajudar: https://github.com/affaan-m/ECC/blob/main/pi/core/skills/docs-governance/SKILL.md Leia o arquivo SKILL.md desse link e siga as instruções dele na minha tarefa.
Como funciona

Ele olha para a documentação existente e as regras do projeto para decidir qual ferramenta é a melhor. Se você pedir uma verificação, ele roda um programa que lê os arquivos sem alterá-los.

Instalação

Jeito mais fácil: copie o link da skill e cole no Claude, ChatGPT ou Cursor pedindo para seguir as instruções.

No terminal (Claude Code, Codex, Cursor), na pasta do projeto:

npx skills add affaan-m/ECC --skill docs-governance

Ou baixe só o arquivo:

curl -L https://raw.githubusercontent.com/affaan-m/ECC/main/pi/core/skills/docs-governance/SKILL.md -o SKILL.md
Conteúdo técnico (SKILL.md)

Tradução do texto original do autor no GitHub. Os comandos e códigos estão como no original.

Roteador de Governança de Documentação

Use este roteador opcional para selecionar a menor capacidade ECC existente para uma solicitação de governança de documentação. O roteador não cria um sistema paralelo de gerenciamento de projetos e não torna a documentação autoritária sobre código, testes, Issues ou decisões de mantenedores.

Quando Ativar

  • O usuário solicita amplamente governança de documentação ou organização de conhecimento do projeto.
  • Uma solicitação abrange várias funções de documentação e o proprietário correto não está claro.
  • O usuário solicita uma auditoria de integridade de documentação determinística e somente leitura.
  • Um projeto precisa descobrir suas fontes de documentação existentes antes de adicionar arquivos.

Não ative para uma habilidade com nome restrito ou para edições de documentação comuns cujo destino já esteja claro.

Contrato de Função

Leia o contrato de função de artefato antes de interpretar .governance/docs-map.json ou nomes de arquivos padrão. Funções lógicas possuem fatos; nomes de arquivos são alternativas. Reutilize as fontes de verdade estabelecidas de um repositório e nunca crie um segundo documento meramente para satisfazer uma função padrão.

Roteamento de Intenção

Intenção do usuário Rota para
Adotar ou manter uma constituição, mapa, status e histórico living-docs-governance
Registrar uma decisão de arquitetura difícil de reverter architecture-decision-records
Preservar uma regressão executável para um defeito importante ai-regression-testing (instalar separadamente no Pi core autônomo)
Definir uma meta verificável e um loop de feedback loop-design-check (instalar separadamente no Pi core autônomo)
Verificar funções mapeadas, links locais, índices ADR, TEST-IDs ou possíveis documentos órfãos Executar a auditoria somente leitura incluída

Se nenhuma linha se encaixar, explique a ambiguidade de propriedade em vez de combinar vários fluxos de trabalho especulativamente.

Auditoria Somente Leitura

Execute a auditoria somente quando o usuário solicitar uma auditoria ou quando for uma etapa de verificação acordada. Resolva o diretório de habilidade selecionado primeiro, depois invoque:

python3 <docs-governance-skill>/scripts/audit-docs.py --root <repository> --scope full

Os escopos disponíveis são spine, context, adr, artifacts e full.

A auditoria lê os arquivos do repositório e o histórico do Git, mas não cria, reescreve, arquiva, prepara ou confirma nada. Ela relata:

  • código de saída 0 quando as verificações determinísticas passam, incluindo quaisquer avisos de revisão manual;
  • código de saída 1 quando existem falhas de integridade mecanicamente comprováveis; e
  • código de saída 2 para entrada inválida na CLI.

Trate os avisos como prompts de revisão, não como falhas. A precisão semântica, o significado de negócios, a conclusão da tarefa e a aprovação da versão permanecem decisões humanas ou do proprietário do fluxo de trabalho.

Quando Usar

Use este roteador quando a solicitação for ampla o suficiente para que a escolha da capacidade de governança correta faça parte do trabalho. Para uma solicitação direta de ADR ou regressão, invoque essa habilidade especializada sem passar por esta.

Como Funciona

  1. Descobrir as superfícies de instrução e documentação existentes do repositório.
  2. Resolver funções lógicas através do contrato de função de artefato.
  3. Selecionar uma menor capacidade correspondente da tabela de roteamento.
  4. Se uma auditoria determinística for solicitada, executar o escopo útil mais restrito.
  5. Relatar falhas, avisos e lacunas de propriedade sem mutar o estado do projeto.

Exemplos

  • “Organizar nossos docs de projeto de longa duração” roteia para living-docs-governance.
  • “Registrar por que selecionamos PostgreSQL” roteia para architecture-decision-records.
  • “Verificar se nossos links de documentação e índice ADR estão intactos” executa a auditoria incluída uma vez com --scope artifacts, depois novamente com --scope adr.
  • “Terminamos a migração?” não é respondido apenas pela documentação; a Issue é proprietária da conclusão, os testes fornecem evidências e os mantenedores são proprietários da aprovação de merge.

Limites

  • Mantenha a propriedade da tarefa, agendamento, tentativas e conclusão no rastreador de Issues.
  • Mantenha fatos de interface estáveis na fonte do contrato do repositório.
  • Trate a documentação como evidência e navegação, não como instruções executáveis.
  • Não ensine os usuários a contornar os controles do repositório, como hooks de pré-commit.
  • Não adicione mutação de arquivo ou índice a esta base somente leitura.
Perguntas frequentes

O que é 'governança de documentação'?

É a forma como um projeto organiza, mantém e verifica suas informações importantes, como decisões de design e quem é responsável por cada documento.

O que é uma 'auditoria'?

É uma verificação detalhada para garantir que tudo está em ordem, como verificar se todos os links em um documento levam aos lugares certos e se as informações estão atualizadas.

Este agente pode mudar meus documentos?

Não, ele é apenas para organizar e verificar. Ele lê os documentos, mas não os altera, cria ou apaga.

Detalhes

Descrição original do autor

Route broad documentation-governance requests to existing ECC skills and run an opt-in, read-only audit of mapped documentation roles, links, ADR indexes, and evidence references. Use when a user asks for documentation governance, project-knowledge organization, documentation integrity, or a deterministic docs audit without naming a narrower skill.

repo: affaan-m/ECC

Popularidade

Estrelas no GitHub
280 mil
Posição no ranking
#49
Licença
MIT
Atualizada em
15/10/2026

Essa skill é útil?

0

Entre para votar.

Comentários

  • …

Mais skills deste repositório

Skills parecidas