Há pessoas que têm jeito para documentar. Eu não tenho, muito menos paciência para tal. Acredito que muitos programadores e administradores de sistemas sofrem do mesmo. Não é que não goste. As ferramentas até agora disponíveis como o Screensteps são caras e restritas a uma aplicação proprietária instalada no computador, o que impossibilita a criação on the go.
Uma opção mais barata como o Clarify foi descontinuada, mas sofria do mesmo problema por ter apenas ter aplicação para Windows e Mac.
Entretanto, existe uma solução para nós e é gratuita.
Entra: Vuepress#
O Vuepress no fundo, é um gerador de site estático, mas ao contrário de outros geradores, vem com um tema inicial próprio para documentação técnica, e não só:
- Documentos em Markdown: podes cria-los no computador, móvel ( Bear) ou web ( Dilinger ou StackEdit) usando um editor que permita pré-visualizar Markdown,
- Suporte multi-idiomas: queres o mesmo documento em duas línguas? Três? Mais? É possível. E cada documento pode ser editado por pessoas diferentes.
- Controle de versão: a documentação (e imagens) pode ser carregada num repositório Git e fazer o deploy (usando o DepoyBot ou o Netlify]) sempre que algum membro atualizar o repositório, mantendo o site sempre atualizado. Para os interessados em aprender, eis um tutorial que ensina o básico (em inglês):
Bónus: Uma boa aplicação de documentação merece outra de captura de ecrã. Recomendo o ShareX. É gratuito e munido de várias opções de captura, edição e gravação.