Instruction file imported from rafaelramosdf/engineer-hive (.github/instructions/documentation-standards.instructions.md). Copyright stays with the author.

Padrões de Documentação

Name: documentation-standards
Author: rafaelramosdf

Idioma

Escrever em português brasileiro (pt-br) por padrão
Manter termos técnicos de engenharia de software em inglês (API, endpoint, backend, frontend, deploy, etc.)
Usar voz ativa
Evitar jarão — explicar termos técnicos na primeira ocorrência quando o público não for técnico
Manter parágrafos curtos (máx. 3-5 frases)

Estrutura

Usar hierarquia clara de títulos (H1 → H2 → H3)
Começar com um breve resumo do que o documento abrange
Usar listas com marcadores para itens, listas numeradas para sequências
Incluir sumário para documentos com mais de 3 seções

Exemplos de Código

Incluir exemplos de código executáveis para documentação técnica
Usar syntax highlighting com identificadores de linguagem
Manter exemplos mínimos e focados no conceito sendo explicado
Incluir output esperado onde útil

Manutenção

Datar todas as decisões de arquitetura e changelogs
Marcar conteúdo depreciado claramente com callouts > **Depreciado**:
Revisar e atualizar documentação a cada mudança de código relacionada

{ "ocm": "1", "id": "rafaelramosdf-engineer-hive-documentation-standards-inst-28bad1", "kind": "skill", "name": "documentation-standards", "description": "Use when creating or updating project documentation, README files, or any markdown documentation. Covers documentation standards and patterns.", "publisher": "rafaelramosdf", "version": "1.0.0", "capabilities": { "domains": [ "general" ], "tags": [ "skill-md", "github-instructions" ], "languages": [ "en" ] }, "quality_prior": 0.6, "examples": [ "Use when creating or updating project documentation, README files, or any markdown documentation. Covers documentation standards and patterns." ], "primary": false, "metadata": { "source": { "provider": "github-instructions", "repository": "https://github.com/rafaelramosdf/engineer-hive", "path": ".github/instructions/documentation-standards.instructions.md", "ref": "101398d9b970e8e3552a47ce831449955ae99312", "url": "https://github.com/rafaelramosdf/engineer-hive/blob/101398d9b970e8e3552a47ce831449955ae99312/.github/instructions/documentation-standards.instructions.md", "key": "rafaelramosdf/engineer-hive/.github/instructions/documentation-standards.instructions.md" }, "applies_to": "docs/**" }, "instructions": "# Padrões de Documentação\n\n## Idioma\n\n- Escrever em **português brasileiro (pt-br)** por padrão\n- Manter termos técnicos de engenharia de software em inglês (API, endpoint, backend, frontend, deploy, etc.)\n- Usar voz ativa\n- Evitar jarão — explicar termos técnicos na primeira ocorrência quando o público não for técnico\n- Manter parágrafos curtos (máx. 3-5 frases)\n\n## Estrutura\n\n- Usar hierarquia clara de títulos (H1 → H2 → H3)\n- Começar com um breve resumo do que o documento abrange\n- Usar listas com marcadores para itens, listas numeradas para sequências\n- Incluir sumário para documentos com ", "cost": { "context_tokens": 310 } }

documentation-standards

About

Padrões de Documentação

Idioma

Estrutura

Exemplos de Código

Links

Manutenção

Use it

Manifest

Reviews