Documentações não precisam ser extensas.

Existem até “padrões de documentações”, como DesignDocs, mas na minha humilde opinião, esse tipo de “encaixe” (delimitar e por num quadrado), só afasta as pessoas de escreverem documentações.

Eu gosto bastante de manter as coisas livres. Esse formato do Notion e do Confluence de ter um emoji e um header são bacanas demais, por exemplo, e é só isso. Do header para baixo a pessoa é livre para escrever e documentar.

Além dessa liberdade, coisas que eu acho importante:

Sempre viva

Sempre revisitar a documentação e atualizar com as novidades. Documentação não tem que ter versão, pode até ter o timestamp da última alteração, mas isso algo automático, ninguém tem que se preocupar em gerar versão.

Bem formatada

Imagina esse texto, aqui mesmo, todo corrido, sem destaque, sem itálico, sem parágrafo, sem cabeçalho… seria extremamente ruim de ler. Documentação tem que ter uma boa formatação e nada exagerado, também não precisa transformar sua documentação em uma árvore de natal.

Informal

Por falar em “transformar em árvore de natal”, também acredito que documentações podem usar gírias, jargões, dialetos, pode e deve ser livre, não precisa ser algo formal. Claro, tudo tem o seu tempero, tudo tem o seu equilíbrio, também não vai me escrever tudo com a gíria da sua quebrada e esperar que as outras pessoas (que não são da sua quebrada) te entendam.