
Essa página é apenas uma sugestão de como podemos fazer o layout de documentações curtas. |
Em qualquer padrão de leitura (seja leitura em F ou leitura em Z), o índice e primeiro tópico sempre serão as primeiras coisas que o usuário vai ler com total atenção. Quanto mais objetiva e assertiva for a introdução e quanto mais bem definidos forem os tópicos, melhor será o aproveitamento do usuário na documentação. |
Espaço para fazer uma introdução sobre o objetivo da documentação, preferencialmente em linguagem de negócio. Aqui pode conter, por exemplo: um breve descritivo de alguma funcionalidade, para que ela serve, para qual tipo de usuário é direcionada, etc.
É interessante evitar:
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.
Exemplo de como podemos utilizar as Tabs para ajudar na organização e entendimento da documentação:
|

Quer contribuir com a evolução da nossa documentação? Clique aqui e dê um feedback sobre esta página!