Lanzamiento de FDS-Dev — herramienta todo en uno de linting de documentación + traducción con IA para desarrolladores no angloparlantes
(github.com/flamehaven01)Lanzamiento de FDS-Dev — herramienta todo en uno de linting de documentación + traducción con IA para desarrolladores no angloparlantes
🤔 En el mundo del código abierto, una de las barreras más grandes que enfrentan los desarrolladores no angloparlantes es escribir documentación en inglés.
Puede que te sientas seguro con el código, pero cuando intentas organizar el README, los comentarios o la documentación en inglés, de pronto te quedas detenido.
Vivimos en una época en la que podemos apoyarnos en traductores con IA, pero aun así,
“¿De verdad suena natural?”
“¿Se habrá transmitido bien lo que quería decir?”
Seguramente muchos se han hecho estas preguntas.
Yo también llevo más de 15 años trabajando como desarrollador en el extranjero, pero
aún hoy lo más natural para mí sigue siendo pensar y escribir en coreano.
Por eso, cuando me concentro en desarrollar, sin darme cuenta termino dejando comentarios en coreano, y cuando llega el momento de ordenar la documentación,
“Si subo esto ahora, quizá parezca un desarrollador que no se preocupa por la calidad de la documentación…”
Muchas veces dudé en publicarlo.
Después de darle muchas vueltas, pensé que sería bueno contar con una herramienta que ayudara, aunque fuera un poco, a desarrolladores no angloparlantes como yo a reducir esa carga.
Así que la hice.
💡 Limitaciones de los linters existentes: “excelentes, pero centrados en el mundo angloparlante”
Ya existen muy buenas herramientas para revisar la calidad de la documentación.
- 🔺 markdownlint → revisión de sintaxis y estilo de Markdown
- 🔺 Vale → revisión de tono, consistencia terminológica y guías de estilo
Estas herramientas son muy potentes para mantener la calidad de la documentación en GitHub.
Pero el problema es que fueron diseñadas asumiendo desarrolladores angloparlantes.
Cuando desarrolladores no angloparlantes de Corea, Japón, Alemania, China y otros países escriben documentación en su propio idioma:
- el linting no funciona correctamente
- la guía de estilo está basada en oraciones en inglés
- y no se consideran entornos de traducción o multilingües
Al final, sigue existiendo la carga de “tener que volver a escribirlo en inglés”.
🚀 Por eso nació FDS-Dev
✨ 1) Linter de documentación ultrarrápido basado en estructura
Va más allá de una simple revisión de estilo:
- ▪️ orden de secciones
- ▪️ encabezados obligatorios
- ▪️ layout completo del documento
También revisa automáticamente estructuras profesionales de documentación como estas.
✨ 2) Traductor con reconocimiento de código basado en IA
Al traducir documentación, comentarios y docstrings:
- ▪️ protege bloques de código
- ▪️ preserva CamelCase / snake_case
- ▪️ mantiene con precisión los términos técnicos
Convierte automáticamente documentación escrita en tu idioma nativo en documentación en inglés con nivel de producción.
✨ 3) La primera herramienta de “internacionalización a nivel de código” para desarrolladores no angloparlantes
Ahora ya no hace falta escribir la documentación en inglés para crear
documentación que cualquiera en el mundo pueda entender.
⚙️ Uso sencillo
pip install --upgrade fds-dev
fds translate README.ko.md --output README.md
fds lint README.md
DeepL, LibreTranslate 등 다양한 번역 백엔드 선택 가능하며
GitHub Actions · Docker 환경도 완벽 지원합니다.
🌏 Contribuye al código abierto
FDS-Dev sigue evolucionando rápidamente incluso ahora.
Sus ⭐ Star, Issue y PR ayudan a definir la dirección de este proyecto.
🙌 Quiero crear un nuevo estándar para desarrolladores no angloparlantes
Un entorno donde puedas concentrarte en el código sin la carga de la documentación,
un ecosistema donde sea posible contribuir al código abierto global sin barreras de idioma—
Espero que FDS-Dev pueda ser ese punto de partida.
¡Agradezco mucho su interés y participación!
4 comentarios
🔥 FDS-Dev v0.0.4 — comparto las novedades de la actualización de hoy
Sigo usando FDS-Dev en casos reales y mejorándolo de forma continua.
Comparto brevemente lo incluido en la actualización v0.0.4 (2025-12-08) publicada hoy.
✅ Cambios principales
Mejora en la lógica de interpretación de configuración
Ahora busca automáticamente
.fdsrc.yamlsegún la ubicación desde donde se ejecutalint/translate.Aunque cambies la configuración por carpeta, se refleja de inmediato sin necesidad de moverte con
cd.Mayor estabilidad del pipeline de traducción
Al usar
language: auto, se evitó el crash que ocurría por la ausencia del objeto de idioma.DeepL ahora usa un timeout predeterminado de 5 segundos y mensajes de error claros, resolviendo el problema de cuelgue del CLI.
Ajustes de calidad de código
En todo el módulo se normalizaron los finales de línea, se eliminaron espacios en blanco al final y se agregaron docstrings mínimos.
Se incorporó un
.pylintrcespecífico del proyecto para que solo detecte “errores reales” sin chocar con los estilos de Black/Ruff.🧪 Pruebas
110 pruebas de
pytestaprobadasPuntuación de
pylint fds_devde 10.00/10Estoy desarrollando este proyecto como una “pequeña herramienta de automatización de calidad para documentación/código basada en lenguaje”,
y hago commits todos los días mientras sigo elevando de forma constante su estabilidad y calidad de ingeniería.
Si te interesa, date una vuelta por el repositorio:
https://github.com/flamehaven01/FDS-Dev
¡También son bienvenidas en cualquier momento las sugerencias de funciones o los issues que necesites reportar!
Lanzamos la versión v0.0.3. Esta actualización se enfocó en reforzar significativamente la seguridad y la calidad de ingeniería.
Los principales cambios son los siguientes:
Seguridad: se agregaron
SECURITY.md, el proceso de reporte de vulnerabilidades, actualizaciones semanales de Dependabot, secret scanning, protección de ramas y una checklist de seguridadCalidad de ingeniería: pre-commit hooks (
black/ruff/isort/yamllint/detect-secrets), cobertura de pruebas de CI obligatoria al 70%,mypy(strict)e integración de toda la configuración de herramientas enpyproject.tomlCI/CD: integración de reportes de cobertura, type checking y multi-lint
Documentación: guía de despliegue empresarial que incluye patrones de Docker/Kubernetes/monorepo, y actualización del tutorial de 10 minutos
Código de ejemplo: se agregaron ejemplos básicos y avanzados
La puntuación total de calidad del repositorio mejoró de 10% → 72.5%.
Notas de la versión: https://github.com/flamehaven01/FDS-Dev/releases/tag/v0.0.3
Los comentarios son bienvenidos en cualquier momento.
¿Un proyecto abierto con licencia MIT? :) Este tipo de proyectos siempre son bienvenidos.
¡Gracias por verlo con buenos ojos! 🙂
La razón por la que lo mantenemos bajo licencia MIT también es para que cualquiera pueda usarlo libremente y hacerlo evolucionar según las necesidades de su equipo o empresa.
Sobre todo, en esta v0.0.3 reforzamos bastante la base de seguridad e ingeniería, así que
podrán aprovecharlo sin problema desde proyectos personales pequeños hasta entornos empresariales.
Si al usarlo se les ocurre alguna idea de mejora o sugerencia, ¡no duden en decirnos cuando quieran! 🙌