The Auto-sync feature is a game changer. It keeps all documentation up to date as Swimm checks any docs pushed to GitHub and will let us know if something needs to be updated. If it's a small change they even do it automatically for you. My team also likes that we're able to view documentation in our CI.

Qualquer pessoa que tenha trabalhado na área de Desenvolvimento de Software sabe o quão tedioso pode ser manter sua documentação em torno do código atualizada. A frase que ouço repetidamente, não importa onde estou, é: "No momento em que você escreve a documentação para o seu código, ela está desatualizada". Com o Swimm, essa observação agora é enfaticamente falsa! O grande problema em torno da documentação de código era/é que não havia uma maneira fácil ou aplicável de alertar os desenvolvedores quando o código referenciado na documentação foi alterado. O produto do Swimm resolve esse problema e faz ainda mais. O Swimm pode se integrar diretamente ao seu fluxo de PR, lançando um erro quando a documentação precisa da adição do desenvolvedor devido a alterações, e pode até sincronizar automaticamente as alterações em situações em que pode inferir as intenções do desenvolvedor. A equipe do Swimm tem adicionado constantemente novos recursos e expandido o que o produto pode fazer. Eles estão sempre abertos a feedbacks e ideias sobre como seu produto pode ser melhorado. Nossa equipe se apaixonou imediatamente pelo produto deles e sabia que ele iria nos ajudar imensamente. Por último, o Swimm não salva nenhum dos arquivos/códigos da sua base de código em seus servidores. Toda a sua documentação viverá dentro do seu repositório existente como arquivos readme dentro de um novo diretório .swm. Assim, você pode adotar o Swimm sem medo de perder sua documentação se tiver que decidir mudar de direção.

Ele permite documentar processos e algoritmos - enquanto adiciona trechos de código que estarão sempre alinhados com o código real.