FDS-Dev lançado — ferramenta all-in-one de linting de documentação + tradução por IA para desenvolvedores não nativos em inglês
(github.com/flamehaven01)FDS-Dev lançado — ferramenta all-in-one de linting de documentação + tradução por IA para desenvolvedores não nativos em inglês
🤔 No mundo open source, uma das maiores barreiras para desenvolvedores que não têm o inglês como idioma nativo é escrever documentação em inglês.
Você pode até ter confiança no código, mas quando tenta organizar o README, os comentários ou a documentação em inglês, de repente trava.
Mesmo vivendo na era em que podemos contar com a ajuda de tradutores por IA,
“Será que isso realmente soa natural?”
“Será que a mensagem ficou exatamente como eu queria?”
Muita gente provavelmente já teve esse tipo de dúvida.
Eu também trabalho há mais de 15 anos como desenvolvedor no exterior, mas ainda assim pensar e escrever em coreano continua sendo o mais natural para mim.
Por isso, quando me concentro no desenvolvimento, percebo que os comentários acabam ficando em coreano, e quando tento organizar a documentação, penso:
“Se eu publicar isso agora, será que vão me ver como um desenvolvedor que não se preocupa com a qualidade da documentação...?”
Houve muitas vezes em que hesitei.
Depois de pensar bastante nisso, senti que seria ótimo existir uma ferramenta que pudesse aliviar ao menos um pouco esse peso para desenvolvedores não nativos em inglês como eu.
Então eu a criei.
💡 Limites dos linters existentes: “excelentes, mas centrados no inglês”
Já existem ótimas ferramentas para verificar a qualidade de documentação.
- 🔺 markdownlint → verificação de sintaxe e estilo de Markdown
- 🔺 Vale → verificação de tom, consistência de termos e guias de estilo
Essas ferramentas são muito poderosas para manter a qualidade da documentação no GitHub.
Mas o problema é que elas foram projetadas assumindo desenvolvedores de língua inglesa.
Quando desenvolvedores da Coreia, Japão, Alemanha, China e outros países escrevem documentação em seus próprios idiomas:
- o lint não funciona corretamente
- os guias de estilo partem de frases em inglês
- ambientes de tradução/multilíngues não são considerados
No fim, continua existindo a pressão de “ter que reescrever tudo em inglês”.
🚀 Por isso nasceu o FDS-Dev
✨ 1) Linter de documentação ultrarrápido com base estrutural
Vai além de uma simples checagem de estilo:
- ▪️ ordem das seções
- ▪️ cabeçalhos obrigatórios
- ▪️ layout geral do documento
Ele também verifica automaticamente estruturas profissionais de documentação como essas.
✨ 2) Tradutor com reconhecimento de código baseado em IA
Ao traduzir documentação, comentários e docstrings:
- ▪️ proteção de blocos de código
- ▪️ preservação de CamelCase / snake_case
- ▪️ manutenção precisa de termos técnicos
Converte automaticamente documentos escritos no idioma nativo em documentação em inglês em nível de produção.
✨ 3) A primeira ferramenta de “internacionalização em nível de código” para desenvolvedores não nativos em inglês
Agora, mesmo sem escrever a documentação em inglês,
é possível criar documentação que qualquer pessoa no mundo consiga entender.
⚙️ Como usar
pip install --upgrade fds-dev
fds translate README.ko.md --output README.md
fds lint README.md
DeepL, LibreTranslate 등 다양한 번역 백엔드 선택 가능하며
GitHub Actions · Docker 환경도 완벽 지원합니다.
🌏 Contribua com o open source
O FDS-Dev continua evoluindo rapidamente.
Suas ⭐ Star, Issue e PR ajudam a definir a direção deste projeto.
🙌 Quero criar um novo padrão para desenvolvedores não nativos em inglês
Um ambiente em que seja possível focar no código sem a pressão da documentação,
um ecossistema em que se possa contribuir para o open source global sem barreiras linguísticas—
Espero que o FDS-Dev seja esse ponto de partida.
Agradeço pelo interesse e pela participação de todos!
4 comentários
🔥 FDS-Dev v0.0.4 — compartilho as novidades da atualização de hoje
Continuo usando o FDS-Dev em situações reais e aprimorando a ferramenta.
Quero compartilhar brevemente o conteúdo da atualização v0.0.4 (2025-12-08), lançada hoje.
✅ Principais mudanças
Melhoria na lógica de interpretação da config
Agora o
.fdsrc.yamlé localizado automaticamente com base no local de execução delint/translate.Mesmo alterando a configuração por pasta, a mudança é aplicada na hora sem precisar mudar de diretório com
cd.Maior estabilidade no pipeline de tradução
Ao usar
language: auto, foi evitado o crash que ocorria quando o objeto de idioma estava ausente.No DeepL, o timeout padrão de 5 segundos e mensagens de erro mais claras resolveram o problema de travamento da CLI.
Ajustes na qualidade do código
Em todo o módulo, foram feitos normalização de fim de linha, remoção de espaços em branco no final e adição mínima de docstrings.
Também foi introduzido um
.pylintrcespecífico do projeto para que apenas “erros reais” fossem sinalizados, sem conflito com o estilo do Black/Ruff.🧪 Testes
110 testes do
pytestaprovadosPontuação
10.00/10nopylint fds_devEstou desenvolvendo este projeto como uma “pequena ferramenta de automação de qualidade para documentação/código baseada em linguagem”
e faço commits todos os dias, elevando continuamente a estabilidade e a qualidade de engenharia.
Se tiver interesse, dê uma olhada no repositório:
https://github.com/flamehaven01/FDS-Dev
Sugestões de recursos ou issues também são sempre bem-vindas!
Lançamos a versão v0.0.3. Esta atualização focou em reforçar significativamente a segurança e a qualidade de engenharia.
As principais mudanças são as seguintes:
Segurança: adição de
SECURITY.md, processo de reporte de vulnerabilidades, atualizações semanais do Dependabot, secret scanning, proteção de branch e checklist de segurançaQualidade de engenharia: pre-commit hooks (
black/ruff/isort/yamllint/detect-secrets), exigência de 70% de cobertura de testes no CI,mypy(strict), integração de todas as configurações de ferramentas nopyproject.tomlCI/CD: integração de relatório de cobertura, type checking e multi-lint
Documentação: guia de implantação enterprise com padrões de Docker/Kubernetes/monorepo, atualização do tutorial de 10 minutos
Código de exemplo: adição de exemplos básicos e avançados
A pontuação geral de qualidade do repositório melhorou de 10% → 72.5%.
Notas da versão: https://github.com/flamehaven01/FDS-Dev/releases/tag/v0.0.3
Feedback é sempre bem-vindo.
Um projeto open source sob licença MIT, é isso mesmo? :) Projetos assim são sempre muito bem-vindos.
Agradeço por olhar com bons olhos! 🙂
O motivo de manter sob a licença MIT também é permitir que qualquer pessoa use livremente e desenvolva de acordo com o ambiente da sua equipe ou empresa.
Especialmente nesta v0.0.3, reforçamos bastante a base de segurança/engenharia, então
desde pequenos projetos pessoais até ambientes enterprise, você poderá usar sem preocupação.
Se tiver qualquer ideia de melhoria ou sugestão enquanto estiver usando, pode me avisar a qualquer momento! 🙌