Problema Resolvido
Em um sistema vivo (site em evolução), o leitor frequentemente não sabe: quem escreveu, com qual objetivo, para qual leitor, e com quais critérios. Isso aumenta ruído, reduz confiança e dificulta reuso.
Esta página resolve isso estabelecendo: contexto, papéis, princípios e rastreabilidade.
Autor e papéis
O autor atua simultaneamente como produtor e consumidor de conhecimento, exercendo curadoria do conteúdo e evolução do sistema (páginas, modelos e componentes).
- Autor/Curador: escreve, seleciona, versiona, integra e registra evidências.
- Aprendiz: valida o entendimento por meio de páginas, exercícios e protótipos.
- Engenheiro de sistemas: transforma conceitos em artefatos verificáveis (modelos, páginas, componentes).
- Leitor (persona externa): consome o material com tempo escasso; precisa de texto útil e navegação clara.
Definições essenciais
| Termo | Definição operacional (curta) | Camada |
|---|---|---|
| Contexto | Conjunto de condições que orienta interpretação, intenção e uso do conteúdo (quem/por quê/para quem/como). | M2 M3 |
| Texto útil | Texto que reduz custo cognitivo do leitor, entrega decisão/ação clara e mantém rastreabilidade. | M3 |
| Evidência | Registro verificável (link, versão, artefato, exemplo) que sustenta uma afirmação ou decisão. | M0 M1 |
| Rastreabilidade | Capacidade de ligar problema → decisão → artefato → versão → evidências de validação. | M1 M3 |
Princípios do autor
- Clareza antes de completude: explicar para um leitor real, com tempo escasso.
- Começar pelo Problema Resolvido: iniciar pelo resultado e depois justificar.
- Camadas M0–M3: separar artefatos, arquitetura, modelos e governança.
- Versão explícita: cada mudança relevante deve aparecer em changelog mínimo.
- Reuso por componentes: padrões replicáveis (cards, botões, modais, layouts).
Critérios de qualidade
Use estes critérios para avaliar a página (como leitor, professor, revisor ou futuro você):
- Clareza: entendi em uma passada? Onde ficou ambíguo?
- Concisão: há excesso que não aumenta utilidade?
- Adequação ao leitor: vocabulário e exemplos são compatíveis com a persona?
- Rastreabilidade: consigo ver “de onde veio” e “como validar”?
Evidências
Ajuste os links abaixo conforme sua estrutura real. O ideal é que esta página tenha “pontes” para M0 e M1.
- M0 — Página canônica relacionada: indexlivro.html (Capa)
- M1 — Arquitetura e padrões: arquitetura.html
- M1 — Padrões de nomenclatura: padrroes_de_nomenclatura_ola.html
- M0 — Exemplo de página no padrão: rede_topicos.html