[DUVIDA] - Gegeração de documentação

Depende muito do que você quer documentar em relação ao ERP. Particularmente, gosto bastante de usar Mkdocs ou Jupyter Notes com Markdown e HTML para produzir a documentação final de forma acessível para todos. Pelo que entendi no seu problema você quer que todos os usuários fiquem cientes de atualizações do ERP? Estilo intranet? Bom, para esse problema acho que um Notion da vida pode ser bem útil e com menor custo de produção.

Se está falando de documentar processos de usuários ou do Software um ferramenta que ando utilizando bastante é o Mermaid.js, vale a pena conferir.

Olá! Entendo perfeitamente a sua dor com a gestão de documentação. O uso de Word para essa finalidade realmente se torna um "inferno". Eu estive lá.

O que fizemos foi migrar para a abordagem "docs as code". A ideia central é tratar a documentação como se fosse código-fonte, utilizando texto plano, controle de versão e um sistema de build.

Formatos de Texto Plano:

• Markdown: Uma família de linguagem de marcação leve e fácil de aprender, amplamente utilizada na Web em vários 'dialetos'.
• reStructuredText (reST): Um sistema de marcação mais poderoso que o Markdown, frequentemente usado com o Sphinx (veja abaixo).
• AsciiDoc: Outra linguagem de marcação com sintaxe clara e recursos avançados. Ao contrário do markdown tem especificação e um "comite" resposável. E tem muita empresa grauda por trás.
• LaTeX: Embora mais complexo que as opções anteriores, ainda é um boa opção. Especialmente se a documentação envolver muita matematica.

Geradores de Documentação:

• MkDocs: Um gerador de sites estáticos simples e eficiente, focado em documentação. Utiliza Markdown como linguagem de marcação.
• Sphinx: Uma ferramenta poderosa para gerar documentação, com suporte para reST e outras linguagens. Oferece recursos avançados como indexação, busca e extensões. É usado para documentar o kernel do linux.. E o python.
• Asciidoctor: O processador de referência para AsciiDoc que gera HTML5, PDF, e outros formatos.
• Pandoc: Um conversor universal de documentos que suporta diversos formatos de entrada e saída, permitindo criar pipelines de geração de documentação personalizadas. Pode ser customizado com scripts em Lua, (ou qualquer outra linguagem).

Uma palestra muito inspiradora sobre como docs as code foi aplicado no Google.
E outra twitter.

Também alguns livros inteiros também sobre o assunto:

Crafting Docs for Success - Diana Lakatos
Docs Like Code: Collaborate and Automate to Improve Technical Documentation - Anne Gentle, Eric Holscher, Diane Skwish, Kelly Holcomb

E muitos papers também

Um abraço e bons estudos!

Uma outra boa alternativa, nao citada é o GitBook

https://www.gitbook.com/

Para documentação técnica usamos Postman e Swagger, mas para documentação de usuário temos um sistema integrado aos proprios sistemas, que disponibiliza ajuda (audio, video, texto, imagem, etc) para cada sessão especifica do software, dentro da propria página aberta, ele pode ser granularizado até por feature espeficica. Apesar de ser muito eficinente a nivel de interesse do usuario, ainda assim da um certo trabalho gerar o material e cadastrar.

Também gostaria de saber se há alguma ferramenta que facilite este processo. Para documentar processos internos aqui na empresa usamos o Confluence, mas não sei se atende para uma documentação que possa ser acessada externamente. Quanto à geração, sugiro por enquanto o uso do ChatGPT. Se você usar o GPT-4 dá pra fazer o upload de arquivos, imagens, etc, e pedir para gerar a documentação à partir destes dados e depois ir corrigindo e melhorando os pontos necessários.