Compétences docs-review
📦

docs-review

Sûr

Revisar Documentação para Conformidade com Guia de Estilo

Inconsistências na documentação reduzem a clareza e profissionalismo. Esta habilidade revisa automaticamente alterações de documentação contra o guia de estilo de escrita do Metabase para garantir tom, estrutura e formatação consistentes.

Prend en charge: Claude Codex Code(CC)
📊 69 Adéquat
1

Télécharger le ZIP du skill

2

Importer dans Claude

Allez dans Paramètres → Capacités → Skills → Importer un skill

3

Activez et commencez à utiliser

Tester

Utilisation de "docs-review". Review docs/installation.md for style guide compliance

Résultat attendu:

  • Problema 1: Tom formal - Linha 15: Isso poderia ser mais conversacional. Considere usar contrações: "Você não pode" em vez de "Você não é capaz de"
  • Problema 2: Título vago - Linha 8: O título poderia ser mais específico. Tente declarar o ponto diretamente: "Execute migrações antes de atualizar" em vez de "Processo de atualização"
  • Problema 3: Texto de link descritivo - Linha 42: Evite linkar a palavra "aqui". Use texto de link descritivo: "Leia o guia de instalação" em vez de "Clique aqui"

Utilisation de "docs-review". Review the documentation in PR 5678

Résultat attendu:

Postou 4 comentários de revisão numerados no PR 5678 do GitHub cobrindo consistência de tom, clareza de títulos e problemas de formatação

Audit de sécurité

Sûr
v6 • 1/21/2026

This skill is a documentation review tool that checks markdown files against the Metabase writing style guide. All 40 static findings were false positives from pattern matching on documentation content. The skill legitimately uses Read, Grep, Glob, and Bash tools for reviewing documentation changes in pull requests or local files. No actual security risks identified.

2
Fichiers analysés
642
Lignes analysées
0
résultats
6
Total des audits
Aucun problème de sécurité trouvé
Audité par: claude Voir l’historique des audits →

Score de qualité

38
Architecture
100
Maintenabilité
87
Contenu
20
Communauté
100
Sécurité
91
Conformité aux spécifications

Ce que vous pouvez construire

Revisão de Documentação em Pull Request

Revisar automaticamente alterações de documentação em pull requests do GitHub e postar comentários numerados como comentários de revisão para ajudar mantenedores a garantir consistência.

Edição Local de Documentação

Revisar arquivos de documentação localmente antes de commitar para capturar problemas de estilo antecipadamente e reduzir iterações de revisão.

Auditoria de Qualidade de Documentação

Auditar documentação existente para conformidade com guia de estilo para identificar áreas que precisam de melhoria e manter voz consistente em grandes conjuntos de documentação.

Essayez ces prompts

Revisar um Arquivo de Documentação 
Review the file docs/getting-started.md for style guide compliance
Revisar Documentação de Pull Request 
Review the documentation changes in pull request 1234
Revisar Múltiplos Arquivos de Documentação 
Review all markdown files in the docs/guides directory for style issues
Revisar Aspectos Específicos de Estilo 
Review docs/api-reference.md focusing on tone, heading structure, and code formatting

Bonnes pratiques

  • Execute a revisão após entender a intenção da documentação para fornecer feedback consciente do contexto
  • Foque em problemas que impactam materialmente a compreensão do leitor e pule preferências estilísticas menores
  • Use o modo de revisão de PR para pull requests do GitHub para postar todo o feedback como uma revisão coesa

Éviter

  • Revisar documentação sem ler primeiro as alterações para entender a intenção geral
  • Marcar cada desvio menor de estilo sem considerar se melhora materialmente a legibilidade
  • Postar comentários de revisão individualmente em vez de coletar todos os problemas e postá-los juntos no modo PR

Foire aux questions

Quais formatos de documentação esta habilidade suporta?
Esta habilidade é projetada para arquivos de documentação markdown. Ela revisa sintaxe markdown, títulos, blocos de código e conteúdo de texto contra o guia de estilo de escrita do Metabase.
Posso usar esta habilidade para documentação que não segue o guia de estilo do Metabase?
A habilidade é calibrada especificamente para regras do guia de estilo do Metabase. Embora alguns princípios sejam universais, muitas verificações são específicas do Metabase e podem não se aplicar a outros padrões de documentação.
Como a habilidade decide entre modo de revisão de PR e revisão local?
A habilidade detecta automaticamente se ferramentas GitHub MCP estão disponíveis. Se a ferramenta mcp github create pending pull request review estiver disponível, ela usa o modo PR e posta comentários no GitHub. Caso contrário, ela gera feedback numerado na conversa.
Por que todos os problemas são numerados sequencialmente?
Numeração sequencial permite referência e rastreamento eficientes. Usuários podem dizer corrigir problemas 1, 3 e 5 e saber claramente quais itens de feedback abordar sem ambiguidade.
Esta habilidade corrige problemas de documentação automaticamente?
Não, esta habilidade apenas revisa e identifica problemas. Ela fornece feedback numerado com correções sugeridas que os usuários podem aplicar manualmente. Isso preserva a intenção do autor e decisões específicas do contexto.
Esta habilidade pode verificar precisão técnica do conteúdo da documentação?
Não, esta habilidade foca em estilo de escrita, tom, estrutura e formatação. Ela não verifica precisão factual, funcionalidade de exemplos de código ou correção técnica das funcionalidades documentadas.

Détails du développeur

Auteur

metabase

Licence

MIT

Dépôt

https://github.com/metabase/metabase/tree/master/.claude/skills/docs-review

Réf

master

Structure de fichiers

📄 SKILL.md