Mehrsprachige Quellcode Documentation - Ob & Wie?

[haentschman]

Moin...8-)

[mein Senf]
Wenn der Quellcode nach extern (Komponenten etc.) geht reicht ein einfaches Englisch aus. Intern bleibts deutsch. Die Übersetzung ist imho überflüssig. Solche Dokumentationsorgien wie in deinem Beispiel (SysUtils) halte ich für übertrieben. Da kann man ja kaum noch Codezeilen finden wenn das in der Implementierung genauso brutal weitergeführt wird.
Ich denke kein Mensch sucht in den Deklarationen nach Informationen zur Verwendung. Ich halte eine "vernünftige" externe Doku wie z.B. http://docwiki.embarcadero.com oder wie z.B. für Komponenten eine Hilfe oder ein PDF für wesentlich eleganter und ausreichend.
:P
[/mein Senf]

[Phoenix]

Zitat:

Zitat von Mavarik (Beitrag 1324143)

Wenn ich/wir ein SDK raus gebe... oder genauer FDK... stellt sich mir die Frage ob es nötig ist eine deutsche Übersetzung an zu bieten...

Meiner Meinung nach ein ganz klares nein.

Und zwar aus folgendem Grund:
Die Basis-Bibliotheken einer jeden gängigen Programmiersprache sind: In englisch.
Auch deren Quellcode-Dokumentation ist: In Englisch.
Nahezu jede erdenkliche Hilfe zu Programmierthemen im Internet findet man mindestens: Auf Englisch.

Ein Software-Entwickler sollte daher des Englischen mindestens readonly ausreichend mächtig sein.

Und falls es einer mal nicht ist, sollte man vielleicht aus den oben genannten Gründen eher darüber nachdenken, die Entwickler vielleicht eher auf einen Fachenglisch-Kurs zu schicken, da man am Ende des Tages vermutlich mehr davon hat, wenn der Entwickler - neben der vermutlich schon existierenden Englischen Doku - auch auf den schier unerschöpflichen Englischen Fachbuch- und Internet-Content zurückgreifen kann als ihm einen nur sehr beschränkten ausschnitt der Problemdomäne mit viel Aufwand ins deutsche zu übersetzen.

Just my 2 cents :)

[Perlsau]

Zitat:

Zitat von Phoenix (Beitrag 1324146)

Ein Software-Entwickler sollte daher des Englischen mindestens readonly ausreichend mächtig sein.

:thumb: Ganz genau, sehe ich auch so: Wenn man schon programmieren will, dann sollte man sich auch die Mühe machen, seine Englischkenntnisse zu verbessern. Ich mache das seit Jahren regelmäßig, so daß ich zumindest einigermaßen gut lesen kann, was in englisch geschrieben steht. Beim gesprochenen Wort hapert es bei mir gewaltig, das liegt wohl am fehlenden Umgang mit englischsprachigen Menschen: Bestimmte Dialekte, insbesondere amerikanische, verstehe ich nur sehr schlecht, und meine Aussprache ist u.a.S. Aber schon damals in den frühen Neunzigern, als ich mit Turbo Pascal begann, erleichterten mir meine Englischkenntnisse den Zugang enorm, sind doch die ausnahmslos in Englisch verfügbaren Befehle, wenn man einmal von allzu kryptischen Bezeichnern absieht, beinahe intuitiv verständlich, wenn man über Grundkenntnisse der englischen Sprache verfügt.

[Dejan Vu]

Also dogmatisch zu verlangen, das Dokumentation immer in Englisch zu erfolgen hat, ist vielleicht etwas kurzsichtig gedacht.

Ich habe für eine deutsche Firma gearbeitet, die Steuerungsprogramme erstellt, die nur dieses Team von Programmierern betreut. Wozu zum Deibel sollten die die Doku in Englisch erstellen, wo doch die wenigsten der Programmierer dieser Sprache so mächtig sind, das sie zusammenhängende Sätze in englisch formulieren können? Deutsch kann jeder, also sind nicht nur Dokumentation, sondern auch sämtliche Bezeichner in Deutsch. Alles andere wäre kreuzdämlich. Natürlich, falls mal ein Schwabe zu den Jungs stößt, hat er ein Problem. :lol:

Derzeit besteht das Team (einer anderen Firma) aus 10 Entwicklern aus 6 Ländern, die eine Legacy Software neu schreibt. Die alte Software enthielt portugiesische Kommentare, portugiesische Bezeichner usw. Natürlich wird *diese* Software in englisch (Quatsch, in C#) geschrieben und dokumentiert.

Es kommt also (wie) immer auf den Kontext an.

[Mavarik]

Zitat:

Zitat von Dejan Vu (Beitrag 1324190)

Ich habe für eine deutsche Firma gearbeitet, die Steuerungsprogramme erstellt, die nur dieses Team von Programmierern betreut. Wozu zum Deibel sollten die die Doku in Englisch erstellen, wo doch die wenigsten der Programmierer dieser Sprache so mächtig sind, das sie zusammenhängende Sätze in englisch formulieren können? Deutsch kann jeder, also sind nicht nur Dokumentation, sondern auch sämtliche Bezeichner in Deutsch. Alles andere wäre kreuzdämlich. Natürlich, falls mal ein Schwabe zu den Jungs stößt, hat er ein Problem. :lol:

...

Es kommt also (wie) immer auf den Kontext an.

Stimmt der Kontext... War der nicht vorgegeben?

Zitat:

Zitat von Mavarik (Beitrag 1324108)

Hierbei geht es nicht darum eigene Projekte zu dokumentieren, sondern um eine Sourcecode-Sammlung für andere Developer.

[DeddyH]

Nö, war er nicht. Geht es um rein deutsch(sprachig)e Developer, oder können die auch irgendwo am Himalaya sitzen? 42!

[Sir Rufo]

Zitat:

Zitat von DeddyH (Beitrag 1324200)

Nö, war er nicht. Geht es um rein deutsch(sprachig)e Developer, oder können die auch irgendwo am Himalaya sitzen? 42!

"andere Developer" war nicht eingeschränkt, somit könnten die sogar auf dem Titan sitzen :stupid:

[Dejan Vu]

Lieber ordentlich in einer Sprache dokumentieren, die man beherrscht, als linkisch, schwer verständlich und teilweise falsch in einer Sprache, die man nicht versteht.

Mein Lieblingsbeispiel war der 'durchlaufende Posten', der von einem Programmierer als 'running Post' betitelt wurde. Ziemlich lustig.

Die Softwaresammlung der Steuerungsprogrammierer (die, die alles in Deutsch gemacht haben), war übrigens für andere Entwickler.

[HeZa]

Hallo Mavarik,

• ihr macht ein SDK und gibt es an Kunden raus
• dir kommt es auf die Dokumentation an, die auch in der IDE zu sehen ist

Dann würde ich die Dokumentation im Quellcode auf jeden Fall nur in English halten. Denn Du kannst nicht wissen, was für Programmierer deine Kunden einsetzen und der Aufwand für eine zweisprachige Version, wäre mir zu hoch.

Wenn ihr davon ausgeht, dass ein sehr hoher Anteil der Programmierer die mit eurem SDK arbeiten Deutsch wesentlich besser versteht als English, würde ich noch eine externe deutsche Dokumentation beilegen.

Und nur im Fall, das Ihr wisst, dass eigentlich nur deutschsprachige Entwickler mit eurem SDK arbeiten und sich das absehbar auch nicht ändern wird, würde ich über eine deutsch Dokumentation im Quellcode nachdenken. Aber das auch nur wenn Kunden bereits eindringlich nach einer deutschen Quellcode Dokumention gefragt hätte.

Wenn es um Aspeckte geht wie, Akzeptanz des SDK im deutschsprachigen Raum, würde ich schauen was die Konkurenz macht (so es denn eine gibt).

[Sir Rufo]

Eine ganz andere Idee wäre eine IDE-Erweiterung, die diese zusätzlichen Informationen bereitstellt.

Die originale Doku ist englisch und über die Erweiterung gibt es die Übersetzung (falls vorhanden).

Bliebe jetzt nur noch die Frage, ob es da ein entsprechendes Interface für die IDE gibt.

Hat da jemand konkrete sachdienliche Hinweise an der Hand?