DEV Community

Cover image for ✨ 21 FERRAMENTAS que ajudam a fazer documentação de software
Engenheira Coelho 🐇
Engenheira Coelho 🐇

Posted on

✨ 21 FERRAMENTAS que ajudam a fazer documentação de software

A documentação técnica é uma das etapas que eu identifico como importantes para o desenvolvimento de software, principalmente quando trabalho com novos projetos. É o fio que une a equipe de desenvolvimento ao cliente, fazendo com que as visões e necessidades de projeto estejam alinhadas.

Essencialmente, essa é uma atividade executada por profissionais especializados em produto, no entanto, a documentação inicial também pode ser desenvolvida por pessoas desenvolvedoras de software, pois está diretamente relacionada ao dia-a-dia do processo de desenvolvimento, e existem ferramentas que podem ser utilizadas dentro do código, gerando uma documentação viva.

O manifesto ágil, orienta que as documentações que forem criadas devem ser somente as mais essenciais e necessárias para o desenvolvimento do produto (Cockburn, 2007). Eu concordo fortemente com esse posicionamento, e acredito que o desenvolvimento de documentação não pode ser negligenciado, pois pode gerar inúmeros benefícios, como os definidos por Highsmith:

Facilitar a comunicação e colaboração;
Melhorar a transferência de conhecimento;
Preservar informações históricas;
Ajudar a melhorias em progresso;
Satisfazer a necessidades legais e regulatórias;
Além disso, também seriam bons pontos:

Facilidade em negociações com o cliente;
Facilita o onboarding de novos colaboradores;
Facilita a manutenção das regras de negócio criticas
Muito se discute entre quais são as questões mais essenciais de documentação, entre elas as que considero importantes são as regras de negócio, diagramas gerais e documentação de API. Por isso, hoje trago 21 plataformas que podem ajudar na documentação:

  1. PlantUML - Utilize linguagem escrita para gerar diagramas, e mantenha no código.
    plantuml.com/starting

  2. C4PlantUML - Implementa a documentação com diagramas utilizando anotações.
    https://github.com/plantuml-stdlib/C4-PlantUML#getting-started

  3. Postman - Use para testar e Gerar uma documentação da sua API.
    www.getpostman.com

  4. APIblueprint - Crie documentações de forma fácil.
    apiblueprint.org/

  5. FlowChat: Crie gráficos e diagramas
    app.diagrams.net/

  6. EdrawMax: Crie diagramas online
    www.edrawmax.com/

  7. Gliffy: Diagramas online com o time.
    www.gliffy.com/

  8. yUML: Desenhe diagramas UML
    yuml.me/

  9. Cucumber: Crie documentações que atualizam no Jira
    cucumber.io/living-documentation/

  10. Crie documentação viva no CI/CD
    https://medium.com/docler-engineering/live-documentation-in-ci-cd-992363409b18

  11. Lucidchart: Crie diagramas e mapas mentais online
    www.lucidchart.com/pages/

  12. Smartdraw: Crie gráficos
    www.smartdraw.com

  13. Drawio: Crie diagramas de casos de uso
    drawio-app.com

  14. online.visual-paradigm: Crie diagramas de casos de uso
    https://online.visual-paradigm.com/pt/diagrams/features/use-case-diagram-software/

  15. Creately: Crie diagramas colaborativos
    creately.com/diagram-type/use-case/

  16. Miro: Crie diagramas e fluxos de forma colaborativa e online
    miro.com/pt/

  17. Confluence: Documente utilizando Markdown
    https://www.atlassian.com/br/software/confluence

  18. Docsify: gerador de documentação com base em anotações no código para javascript.
    https://docsify.js.org/#/

  19. Utilize o Github para documentar:
    https://docs.github.com/pt/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax

  20. JSdoc: Utilize anotações para documentar código javascript.
    jsdoc.app

  21. swagger: Utilize anotações para documentar código Java.
    https://swagger.io/

O que achou da lista? Adicionaria mais algum site?

Deixe um comentário! Isso me ajuda bastante a continuar produzindo conteúdo.

Discussion (0)