Modelo de documentação 7-Ações
Um modelo daquilo que os leitores precisam de encontrar na documentação técnica, não um modelo dos conteúdos a escrever.
As sete ações
Um modelo descritivo das necessidades dos utilizadores 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 caso disso, 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 é possível fazer com uma baixa barreira à entrada.
- Praticar Treinar
- Aprender a utilizar o produto nas operações quotidianas e habituais.
- Recordar Relembrar
- Relembrar informações que não foi possível memorizar, desde parâmetros até 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 razão existe o modelo de documentação 7-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 7-Ações — Instale uma skill para agentes que ajuda a planear 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áquinas
- 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 7-Ações · 2025-01-09 · CC BY 4.0 · Introdução · Fabrizio Ferri Benedetti