9 points par flamehaven01 2025-11-20 | 4 commentaires | Partager sur WhatsApp

Lancement de FDS-Dev — un outil tout-en-un de linting documentaire + traduction IA pour les développeurs non anglophones

🤔 Dans le monde de l’open source, l’un des plus grands obstacles pour les développeurs non anglophones est la rédaction de documentation en anglais.

On peut être à l’aise avec le code, mais dès qu’il faut organiser un README, des commentaires ou de la documentation en anglais, on se retrouve facilement bloqué.
Nous vivons à une époque où l’on peut s’aider de traducteurs IA, mais

« Est-ce vraiment une formulation naturelle ? »
« Le message passe-t-il bien comme je l’avais voulu ? »

Beaucoup se sont probablement déjà posé ces questions.

Moi aussi, cela fait plus de 15 ans que je travaille comme développeur à l’étranger,
mais penser et écrire dans ma langue maternelle reste ce qu’il y a de plus naturel.
Alors, quand je me concentre sur le développement, je finis souvent par laisser des commentaires dans ma langue, et lorsque vient le moment de mettre la documentation en forme,

« Si je publie ça maintenant, est-ce que je vais donner l’image d’un développeur qui ne se soucie pas de la qualité de sa documentation… »

Il m’est souvent arrivé d’hésiter.

À force de me poser ces questions, je me suis dit qu’il serait utile d’avoir un outil capable d’alléger un peu cette charge pour les développeurs non anglophones comme moi.

Alors je l’ai créé.


💡 Les limites des linters existants : « excellents, mais pensés pour les anglophones »

Il existe déjà d’excellents outils pour vérifier la qualité de la documentation.

  • 🔺 markdownlint → vérification de la syntaxe et du style Markdown
  • 🔺 Vale → vérification du ton, de la cohérence terminologique et des guides de style

Ces outils sont très puissants pour maintenir la qualité de la documentation sur GitHub.
Mais le problème, c’est que ces outils ont été conçus en partant du principe que le développeur est anglophone.

Lorsque des développeurs non anglophones de Corée, du Japon, d’Allemagne ou de Chine rédigent leur documentation dans leur langue :

  • le linting ne fonctionne pas correctement ;
  • les guides de style reposent sur des phrases anglaises ;
  • les environnements de traduction et multilingues ne sont pas pris en compte.

Au final, il reste toujours cette pression : « il faut tout réécrire en anglais ».


🚀 Voici donc FDS-Dev

✨ 1) Un linter documentaire ultra-rapide basé sur la structure

Au-delà d’un simple contrôle de style :

  • ▪️ ordre des sections
  • ▪️ en-têtes obligatoires
  • ▪️ mise en page globale du document

Le tout permet aussi de vérifier automatiquement une structure documentaire professionnelle.

✨ 2) Un traducteur basé sur l’IA, conscient du code

Lors de la traduction de documentation, de commentaires ou de docstrings :

  • ▪️ protection des blocs de code
  • ▪️ préservation de CamelCase / snake_case
  • ▪️ conservation précise des termes techniques

Il transforme automatiquement les documents rédigés dans votre langue maternelle en documentation anglaise de niveau production.

✨ 3) Le premier outil de « code-level internationalization » pour les développeurs non anglophones

Il n’est désormais plus nécessaire de rédiger la documentation directement en anglais pour créer
une documentation compréhensible par n’importe qui dans le monde.


⚙️ Utilisation simple

pip install --upgrade fds-dev  
fds translate README.ko.md --output README.md  
fds lint README.md  
DeepL, LibreTranslate 등 다양한 번역 백엔드 선택 가능하며  
GitHub Actions · Docker 환경도 완벽 지원합니다.  

🌏 Contribuez à l’open source

FDS-Dev continue d’évoluer rapidement.
Vos ⭐ Star, Issues et PR façonnent l’orientation du projet.

🙌 Je veux créer un nouveau standard pour les développeurs non anglophones

Un environnement où l’on peut se concentrer sur le code sans la charge mentale de la documentation,
un écosystème où l’on peut contribuer à l’open source mondial sans barrière linguistique —

J’espère que FDS-Dev pourra en être le point de départ.
Merci pour votre intérêt et votre participation !

4 commentaires

 
flamehaven01 2025-12-08

🔥 FDS-Dev v0.0.4 — je partage les nouveautés de la mise à jour du jour

Je continue d’améliorer FDS-Dev en l’utilisant au quotidien dans des cas réels.
Je partage brièvement le contenu de la mise à jour v0.0.4 (2025-12-08) déployée aujourd’hui.

✅ Principaux changements

Amélioration de la logique d’interprétation de la config
Désormais, .fdsrc.yaml est détecté automatiquement en fonction de l’emplacement d’exécution de lint/translate.
Même si vous modifiez la configuration au niveau d’un dossier, elle est appliquée immédiatement sans avoir à vous déplacer avec cd.

Renforcement de la stabilité du pipeline de traduction
En cas d’utilisation de language: auto, nous avons empêché les crashs causés par l’absence de l’objet de langue.
Pour DeepL, nous avons résolu les problèmes de blocage du CLI avec un timeout par défaut de 5 secondes et des messages d’erreur plus explicites.

Nettoyage de la qualité du code
Normalisation des fins de ligne dans l’ensemble des modules, suppression des espaces de fin de ligne, ajout d’un minimum de docstrings.
Introduction d’un .pylintrc spécifique au projet afin de ne remonter que les « erreurs réelles » sans conflit avec les styles Black/Ruff.

🧪 Tests

110 tests pytest validés

Score de 10.00/10 obtenu sur pylint fds_dev

Je développe ce projet comme un « petit outil d’automatisation de la qualité documentaire et du code basé sur le langage »,
et j’augmente chaque jour sa stabilité et sa qualité d’ingénierie en commitant quotidiennement.

Si cela vous intéresse, n’hésitez pas à aller voir le dépôt :
https://github.com/flamehaven01/FDS-Dev

Les suggestions de fonctionnalités et les issues sont toujours les bienvenues !

 
flamehaven01 2025-11-20

La version v0.0.3 a été publiée. Cette mise à jour s’est concentrée sur un renforcement important de la sécurité et de la qualité d’ingénierie.

Principaux changements :

Sécurité : ajout de SECURITY.md, du processus de signalement des vulnérabilités, des mises à jour hebdomadaires Dependabot, du secret scanning, de la protection de branche et d’une checklist de sécurité

Qualité d’ingénierie : pre-commit hooks (black/ruff/isort/yamllint/detect-secrets), couverture de tests CI imposée à 70 %, mypy (strict), unification de toute la configuration des outils dans pyproject.toml

CI/CD : intégration des rapports de couverture, du type checking et du multi-lint

Documentation : guide de déploiement enterprise incluant les patterns Docker/Kubernetes/monorepo, mise à jour du tutoriel de 10 minutes

Code d’exemple : ajout d’exemples de base et avancés

Le score global de qualité du dépôt est passé de 10 % → 72.5 %.

Notes de version : https://github.com/flamehaven01/FDS-Dev/releases/tag/v0.0.3

Les retours sont les bienvenus à tout moment.

 
dntjrdl 2025-11-20

Un projet open source sous licence MIT, dites donc :) ce genre de projet est toujours le bienvenu.

 
flamehaven01 2025-11-20

Merci pour votre regard bienveillant ! 🙂
Si nous le maintenons sous licence MIT, c’est aussi pour que chacun puisse l’utiliser librement et le faire évoluer selon les besoins de son équipe ou de son entreprise.

Nous avons notamment beaucoup renforcé les fondations en matière de sécurité et d’ingénierie dans cette version v0.0.3,
de sorte que vous puissiez l’utiliser sereinement, du petit projet personnel jusqu’à un environnement d’entreprise.

Si vous l’utilisez et avez des idées d’amélioration ou des suggestions, n’hésitez pas à me le faire savoir à tout moment ! 🙌