Criar Documentação de Software Diataxis
As equipes frequentemente precisam de documentação que corresponda à intenção do usuário em tutoriais, guias práticos, páginas de referência e explicações. Esta skill orienta Claude, Codex e Claude Code a esclarecer o escopo, propor um esboço e redigir Markdown estruturado.
Esta habilidade faz parte de um pacote
Instale o pacote completo para obter todas as habilidades que a tarefa exige, com um único comando.
Copie esta solicitação para o seu Agente. Ela inclui a página canônica do Skill e o manifesto.
Review the Skillstore skill "documentation-writer" from https://skillstore.io/skills/github-documentation-writer.md and its manifest at https://skillstore.io/api/skills/github-documentation-writer/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.Seu Agente ainda deve apresentar o plano e solicitar qualquer confirmação exigida pela política de segurança.
Use estes links quando um agente de IA, crawler ou script precisar de contexto limpo em vez de ler a página completa.
Usando "documentation-writer". Uma solicitação para escrever documentação de integração para um novo recurso de desenvolvedor.
Resultado esperado:
Perguntas de esclarecimento sobre público e objetivo, seguidas por um esboço de tutorial focado em um primeiro resultado bem-sucedido.
Usando "documentation-writer". Um esboço aprovado para uma tarefa de implantação.
Resultado esperado:
Um guia prático em Markdown com pré-requisitos, etapas ordenadas, resultados esperados e notas concisas de solução de problemas.
Usando "documentation-writer". Arquivos Markdown existentes que definem o tom e a terminologia do produto.
Resultado esperado:
Um rascunho de documentação revisado que segue a mesma voz, nomenclatura e estrutura sem copiar o texto-fonte.
The skill contains prompt guidance for technical writing and no executable network operation. The Diátaxis website URL is a framework citation, not a request target or data transfer mechanism.
Compartilhe o relatório de avaliação versionado, o badge neutro, o cartão incorporável e as citações. A Skillstore apresenta evidências sem decidir se este Skill é seguro.
https://skillstore.io/skills/github-documentation-writer/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report[](https://skillstore.io/skills/github-documentation-writer?utm_source=security_passport_badge)<a href="https://skillstore.io/skills/github-documentation-writer?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/github-documentation-writer/security.svg" alt="Skillstore security assessment" loading="lazy"></a><iframe src="https://skillstore.io/embed/skills/github-documentation-writer.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>github. (2026). documentation-writer security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/github-documentation-writer/audits/5@techreport{github-github-documentation-writer-2026,
author = {github},
title = {documentation-writer security audit report (audit version 5)},
institution = {Skillstore},
year = {2026},
number = {5},
url = {https://skillstore.io/skills/github-documentation-writer/audits/5},
note = {Author version unspecified}
}cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "documentation-writer security audit report (audit version 5)"
version: "unspecified"
type: report
authors:
- name: "github"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/github-documentation-writer/audits/5"
identifiers:
- type: other
value: "skillstore:github-documentation-writer:audit:5"
description: "Skillstore immutable audit report identifier"
Cada autor permanece como um skill instalável separado. A variante recomendada é classificada pelas evidências do Skillstore.
Por que esta variante está em primeiro
github-documentation-writer
2026-09-09
c0ntr0lledcha0s-documentation-writer
2026-09-09
Crie um esboço e um rascunho focados em aprendizado para usuários que precisam de uma primeira experiência bem-sucedida guiada.
Transforme uma tarefa específica em uma sequência clara de etapas com escopo e pré-requisitos.
Organize fatos técnicos em material de referência conciso para consulta recorrente e manutenção.
Preciso de documentação para [product or feature]. Ajude-me a escolher se deve ser um tutorial, guia prático, página de referência ou explicação. Faça primeiro quaisquer perguntas de esclarecimento.
Crie um esboço baseado em Diataxis para um [document type] sobre [topic]. O público-alvo é [audience], o objetivo é [goal] e o escopo é [scope].
Use o esboço aprovado para escrever o documento Markdown completo. Mantenha a linguagem simples, precisa e consistente com os detalhes do produto fornecidos.
Revise estes rascunhos de documentação quanto ao alinhamento com Diataxis. Identifique propósitos mistos, contexto de público ausente, problemas de escopo e inconsistências de terminologia antes de propor revisões.
Autor
githubLicença
MIT
Revisão da Skillstore
r2
Aviso de versão
O autor não declarou uma versão.
Referência
c43861a65bb95efcae259cd161c9d6f4dc7eec6f
Atualidade da manutenção
25/07/2026
Uso
20 downloads · 124 visualizações
Estrutura de arquivos
📄 SKILL.md
Criar Documentos de Requisitos de Produto
As equipas começam frequentemente funcionalidades com objetivos vagos e requisitos em falta. Esta skill transforma ideias de produto em PRDs estruturados com critérios mensuráveis e contexto técnico.
Manage Stacked GitHub Pull Requests
Large changes become difficult to review when unrelated concerns share one branch. This skill guides dependency-based branch planning and non-interactive stacked PR workflows.
Crie melhores aplicações Spring Boot
Projetos Spring Boot podem se tornar inconsistentes entre camadas, configuração, testes e segurança. Esta habilidade oferece orientações concisas de boas práticas para projetar serviços Java manuteníveis com Spring Boot.
Refatore Código com Segurança
Bases de código grandes se tornam difíceis de alterar quando a estrutura, os nomes e as responsabilidades se desviam. Esta skill orienta etapas seguras de refatoração que preservam o comportamento enquanto melhoram a manutenibilidade.
Criar Commits Git Convencionais Claros
Commits pouco claros tornam as revisões e o histórico de lançamentos mais difíceis de entender. Esta skill analisa as alterações do repositório, prepara os arquivos selecionados e cria uma mensagem de Conventional Commit.
Create Lean Multi-Stage Dockerfiles
Container images can retain unnecessary build tools and rebuild dependencies too often. This skill guides Dockerfile design with separate build stages, efficient caching, and minimal runtime dependencies.
Criar Documentação Profissional em Markdown
por AutumnsGrove
Equipes precisam de documentação de projeto clara que permaneça consistente entre arquivos README, changelogs e guias de contribuição. Markdown Pro fornece modelos, estrutura e fluxos de trabalho auxiliares para documentação técnica refinada.
Escrever documentação da Metabase
por metabase
A documentação de produto muitas vezes fica formal demais, vaga ou difícil de examinar rapidamente. Esta habilidade ajuda Claude, Codex e Claude Code a escrever documentação no estilo da Metabase que seja clara, direta e focada no leitor.
Formatar Artigos em Markdown
por jimliu
Rascunhos muitas vezes não têm estrutura consistente, frontmatter e tipografia legível. Esta skill transforma texto simples ou Markdown bruto em Markdown organizado, pronto para revisão.
Elabore Documentação Melhor com Revisão Guiada
por ZhanlinCui
Documentos complexos muitas vezes falham porque o contexto, a estrutura e as suposições do leitor não estão claros. Esta skill orienta Claude, Codex ou Claude Code por um fluxo de trabalho repetível de coautoria que reúne contexto, redige seções e testa a compreensão do leitor.
Crie READMEs Focados no Público-Alvo
por softaworks
READMEs genéricos muitas vezes não atendem às necessidades de colaboradores, colegas de equipe ou futuros mantenedores. Esta skill orienta Claude, Codex e Claude Code por meio de perguntas sobre o público, templates e verificações de qualidade.
Gerar Documentação de Código Sustentável
por sickn33
A documentação manual frequentemente fica defasada em relação ao código ativo. Esta skill ajuda Claude, Codex e Claude Code a criar documentação clara e planos de automação.