FDS-Dev veröffentlicht — All-in-One-Tool für Dokumenten-Linting + KI-Übersetzung für nicht englischsprachige Entwickler

 (github.com/flamehaven01)
9 Punkte von flamehaven01 2025-11-20 | 4 Kommentare | Auf WhatsApp teilen

FDS-Dev veröffentlicht — All-in-One-Tool für Dokumenten-Linting + KI-Übersetzung für nicht englischsprachige Entwickler

🤔 In der Open-Source-Welt ist eine der größten Hürden für nicht englischsprachige Entwickler das Schreiben von Dokumentation auf Englisch.

Im Code ist man sicher, aber sobald man README, Kommentare oder Dokumentation auf Englisch formulieren soll, stockt man plötzlich.
Wir leben zwar in einer Zeit, in der man sich von KI-Übersetzern helfen lassen kann, aber

„Klingt das wirklich natürlich?“
„Wird das, was ich beabsichtigt habe, auch richtig vermittelt?“

Solche Fragen haben sich vermutlich viele schon gestellt.

Auch ich arbeite seit über 15 Jahren als Entwickler im Ausland,
und trotzdem ist es für mich nach wie vor am natürlichsten, auf Koreanisch zu denken und zu schreiben.
Wenn ich mich also ganz auf die Entwicklung konzentriere, bleiben Kommentare irgendwann doch auf Koreanisch stehen, und wenn ich die Dokumentation aufbereiten will, denke ich oft:

„Wenn ich das jetzt so hochlade, wirke ich vielleicht wie ein Entwickler, dem die Qualität der Dokumentation egal ist …“

Deshalb habe ich oft gezögert.

Nach all diesen Überlegungen dachte ich, es wäre gut, ein Tool zu haben, das nicht englischsprachigen Entwicklern wie mir diese Last wenigstens ein Stück weit abnimmt.

Also habe ich es gebaut.

💡 Grenzen bestehender Linter: „Großartig, aber auf den englischsprachigen Raum ausgerichtet“

Es gibt bereits hervorragende Tools zur Prüfung der Dokumentationsqualität.

  • 🔺 markdownlint → Prüfung von Markdown-Syntax und -Stil
  • 🔺 Vale → Prüfung von Tonalität, Terminologiekonsistenz und Styleguides

Diese Tools sind sehr leistungsfähig, wenn es darum geht, die Dokumentationsqualität auf GitHub zu sichern.
Das Problem ist jedoch, dass diese Tools für englischsprachige Entwickler konzipiert wurden.

Wenn Entwickler aus Korea, Japan, Deutschland, China und anderen nicht englischsprachigen Ländern Dokumentation in ihrer Muttersprache schreiben:

  • funktioniert das Linting nicht richtig,
  • basieren Styleguides auf englischen Sätzen,
  • und Übersetzung bzw. mehrsprachige Umgebungen werden nicht berücksichtigt.

Am Ende bleibt also doch die Last, „alles noch einmal auf Englisch schreiben zu müssen“.

🚀 Deshalb gibt es FDS-Dev

✨ 1) Ultraschneller, strukturbasierter Dokumentations-Linter

Über einfache Stilprüfungen hinaus werden automatisch auch professionelle Dokumentationsstrukturen geprüft, zum Beispiel:

  • ▪️ Reihenfolge der Abschnitte
  • ▪️ erforderliche Header
  • ▪️ gesamtes Dokumenten-Layout

✨ 2) KI-basierter, codebewusster Übersetzer

Beim Übersetzen von Dokumentation, Kommentaren und Docstrings:

  • ▪️ Schutz von Codeblöcken
  • ▪️ Erhalt von CamelCase / snake_case
  • ▪️ präzise Beibehaltung technischer Begriffe

Dadurch werden in der Muttersprache geschriebene Dokumente automatisch in produktionsreife englische Dokumentation umgewandelt.

✨ 3) Das erste Tool für „Internationalisierung auf Code-Ebene“ für nicht englischsprachige Entwickler

Jetzt muss Dokumentation nicht mehr direkt auf Englisch geschrieben werden,
sondern es lassen sich Dokumente erstellen, die von jedem auf der Welt verstanden werden können.

⚙️ Einfache Verwendung

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

🌏 Beteiligen Sie sich an Open Source

FDS-Dev entwickelt sich auch jetzt noch rasant weiter.
Ihre ⭐ Stars, Issues und PRs bestimmen die Richtung dieses Projekts.

🙌 Ich möchte einen neuen Standard für nicht englischsprachige Entwickler schaffen

Eine Umgebung, in der man sich ohne Belastung durch Dokumentation auf den Code konzentrieren kann,
ein Ökosystem, in dem man ohne Sprachbarrieren zu globalem Open Source beitragen kann —

Ich hoffe, dass FDS-Dev dafür der Ausgangspunkt sein kann.
Ich freue mich über Ihr Interesse und Ihre Beteiligung!

Verwandte Beiträge

4 Kommentare

 
flamehaven01 2025-12-08

🔥 FDS-Dev v0.0.4 — ich teile die heutigen Update-Neuigkeiten

Ich verbessere FDS-Dev laufend weiter, während ich es weiterhin im produktiven Einsatz nutze.
Hier ein kurzer Überblick über die heute veröffentlichte Aktualisierung v0.0.4 (2025-12-08).

✅ Wichtige Änderungen

Verbesserte Config-Interpretationslogik
Ab sofort wird .fdsrc.yaml automatisch anhand des Ausführungsorts von lint/translate gesucht.
Auch wenn ihr Einstellungen auf Ordnerebene ändert, werden sie sofort übernommen, ohne dass ein cd-Wechsel nötig ist.

Höhere Stabilität der Übersetzungspipeline
Bei Verwendung von language: auto wurde ein Crash verhindert, der durch fehlende Sprachobjekte entstehen konnte.
Für DeepL wurden ein Standard-Timeout von 5 Sekunden sowie klare Fehlermeldungen eingeführt, wodurch das Problem hängender CLI-Prozesse gelöst wurde.

Überarbeitung der Code-Qualität
Projektweit wurden Zeilenenden normalisiert, nachgestellte Leerzeichen entfernt und minimale Docstrings ergänzt.
Zusätzlich wurde eine projektspezifische .pylintrc eingeführt, damit nur noch „echte Fehler“ erfasst werden, ohne Konflikte mit dem Black-/Ruff-Stil.

🧪 Tests

110 pytest-Tests bestanden

pylint fds_dev mit einer Bewertung von 10.00/10

Ich entwickle dieses Projekt als „kleines sprachbasiertes Automatisierungstool für Dokumentations- und Code-Qualität“ weiter
und erhöhe durch tägliche Commits kontinuierlich die Stabilität sowie die Engineering-Qualität.

Wenn es euch interessiert, schaut euch gern das Repository an:
https://github.com/flamehaven01/FDS-Dev

Feature-Vorschläge oder Issues sind jederzeit willkommen!
 
flamehaven01 2025-11-20

Version v0.0.3 wurde veröffentlicht. Dieses Update konzentriert sich darauf, Sicherheit und Engineering-Qualität deutlich zu stärken.

Die wichtigsten Änderungen sind wie folgt:

Sicherheit: Hinzugefügt wurden SECURITY.md, ein Prozess für Schwachstellenmeldungen, wöchentliche Dependabot-Updates, Secret Scanning, Branch Protection und eine Sicherheits-Checkliste

Engineering-Qualität: pre-commit hooks (black/ruff/isort/yamllint/detect-secrets), erzwungene CI-Testabdeckung von 70 %, mypy(strict), Zusammenführung aller Tool-Konfigurationen in pyproject.toml

CI/CD: Integration von Coverage-Reports, Type Checking und Multi-Lint

Dokumentation: Enterprise-Bereitstellungsleitfaden einschließlich Docker-/Kubernetes-/Monorepo-Patterns, aktualisiertes 10-Minuten-Tutorial

Beispielcode: grundlegende/fortgeschrittene Beispiele hinzugefügt

Der gesamte Repository-Qualitätsscore wurde von 10 % → 72,5 % verbessert.

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

Feedback ist jederzeit willkommen.
 
dntjrdl 2025-11-20

Ein Open-Source-Projekt unter MIT-Lizenz :) Solche Projekte sind immer willkommen.
 
flamehaven01 2025-11-20

Vielen Dank für die positive Rückmeldung! 🙂
Der Grund, warum wir das Projekt unter der MIT-Lizenz weiterführen, ist auch, dass es jeder frei nutzen und passend zur eigenen Team- oder Unternehmensumgebung weiterentwickeln kann.

Insbesondere in dieser v0.0.3 haben wir die Sicherheits- und Engineering-Basis deutlich verstärkt,
sodass es sich vom kleinen persönlichen Projekt bis hin zur Enterprise-Umgebung bedenkenlos einsetzen lässt.

Falls Ihnen bei der Nutzung Verbesserungsideen oder Vorschläge einfallen, lassen Sie es uns jederzeit wissen! 🙌