Modelo de documentação de sete ações
Um modelo do que os leitores precisam na documentação, não do conteúdo que se deve escrever.
As sete ações
Um modelo descritivo das necessidades dos usuários de documentação técnica. Sete ações abrangem os objetivos que quem consulta a documentação pode querer alcançar: Avaliar, Compreender, Explorar, Praticar, Recordar, Desenvolver e Resolver.
- Avaliar Discernir
- Discernir as principais qualidades do produto e, se for o caso, compará-lo com outros.
- Compreender Aprender
- Compreender as abstrações e os modelos mentais em que o produto se baseia.
- Explorar Descobrir
- Experimentar o produto e descobrir o que ele faz, com uma barreira de entrada baixa.
- Praticar Treinar
- Aprender a usar o produto nas operações cotidianas e habituais.
- Recordar Relembrar
- Relembrar informações que não foi possível memorizar, de parâmetros a códigos de erro.
- Desenvolver Integrar
- Construir sobre o produto, ampliá-lo ou integrá-lo para criar valor adicional.
- Resolver Solucionar
- Diagnosticar e resolver problemas de forma eficiente, muitas vezes sob pressão.
Para agentes
- Introdução — Por que existe o modelo de documentação de sete ações.
- Glossário — Todos os termos do modelo: as sete ações, os seus verbos alternativos e o significado de cada uma.
- Skill do modelo de documentação de sete ações — Instale uma skill para agentes que ajuda a planejar e melhorar a documentação com o modelo de sete ações.
- Versões em Markdown — Cada página também está disponível como index.md.
- model.json — Modelo legível por máquina
- llms.txt — Índice do site para modelos de linguagem
- sitemap.md — Mapa do site
- AGENTS.md — Como os agentes devem ler este site
Modelo de documentação de sete ações · 2025-01-09 · CC BY 4.0 · Introdução · Fabrizio Ferri Benedetti