In welcher Sprache Dokumentieren?



  • Doku wird immer in Muttersprache verfasst. Vielleicht brech ich mir hier einen ab und schreib den ganzen Scheiß auch noch auf Englisch. 😃 Meißtens lesen es doch eh nur Deutsche, die dann beim Lesen entweder nur kotzen oder abfeiern.



  • Hm kommt wohl drauf an, wo man arbeitet und für was die Doku halt ist.



  • Man sollte die Sprache nehmen, die der Kunde wünscht.
    Das ist in meinem Fall Deutsch. *puh*

    Aber ich habe auch schon an einem Projekt gearbeitet, wo komplett incl. Kommentaren, Variablennamen und sämtlichen Dokumenten Englisch verwendet wurde.
    Da lernt man es. 👍

    Seitdem merke ich nichtmal wirklich, ob ich nun gerade Deutsch oder Englisch lese. Geantwortet wird auch automatisch in der passenden Sprache. 😃
    Nur beim Sprechen brauche ich nen Moment zum Eingewöhnen, da habe ich zu wenig Praxis - leider. 😞



  • Also wir arbeiten für einen deutschen Kunden und entsprechend ist deutsch völlig i.O. Kenn auch niemanden, der hier auf englisch dokumentiert. Es gibt ein paar Ausländer, die so schlechtes deutsch können, das sie die Ausnahme sind und hier dann auf englisch dokumentieren. Aber halt Ausnahmen.


  • Mod

    estartu_de schrieb:

    Kommentaren, Variablennamen und sämtlichen Dokumenten Englisch verwendet wurde.
    Da lernt man es. 👍

    Wie kommst Du denn darauf?

    Hast Du mal gesehen, in wie vielen "deutschen englischen Kommentaren" fälschlicherweise "actual" als Begriff verwendet wird, weil der Schreiber "aktuell" meint, aber nicht weiß daß er "current" schreiben müßte?

    Ohne Kontrolle durch einen Leser der Kommentare mit Feedback lernt man doch nicht das Schreiben englischer Kommentare... wo ist nämlich das zum Lerneffekt benötigte Feedback?



  • - Entwicklerdoku: Haben wir nicht. 😃 Wer ein Projekt hat, behält es meistens. Deshalb auch deutsche Codekommentare.
    - Benutzerdoku: Deutsch. Alles weitere erledigt dann ein Übersetzungsbüro.


  • Mod

    HEZ schrieb:

    - Entwicklerdoku: Haben wir nicht. 😃 Wer ein Projekt hat, behält es meistens.

    Nicht unüblich, aber wie löst Ihr folgende Probleme:

    - Urlaubsvertretung/Krankheit/Kündigung
    - Vereinheitlichung der Programme/Vereinheitlichung des Wissens ("learn from others' code")?



  • Nun, gute Frage, aber die Antwort wird dich vielleicht schockieren: Gar nicht.
    Auch mit Doku wäre niemand in der Lage, einfach so mal eben ein Projekt eines Kollegen zu übernehmen. Bis man größere, sinnvolle Änderungen am fremden Code vornehmen kann, vergehen Wochen an Einarbeitung, die durch eine Doku vielleicht reduziert werden könnte; aber das Erstellen der Doku braucht auch ein paar Wochen.

    Ist also ein Kollege mal ein paar Wochen krank oder im Urlaub, bleibt das Projekt liegen und die Kollegen versuchen die Kunden mit ein paar dilletantischen Lösungsvorschlägen hinzuhalten. 😉 Wenn er kündigt, muss der Kollege, der gerade am wenigsten zu tun hat, sich in die Programmlogik reinarbeiten und das Projekt übernehmen.

    Vereinheitlichung der Programme: Nun... sogar wir glauben inzwischen, dass wir da was tun sollten... wir haben noch nicht mal die Anzahl der Leerzeichen bei Einrückungen gleich. Ein Kollege verwendet ungarische Notation, der Nächste lieber erklärendere Variablennamen, ob man nun einfach irgendwo eine Funktion hinschreibt oder sie in eine Klasse packt, ist jedem selbst überlassen. Der Bedarf für Konventionen war nie wirklich da, denn ein Projekt wird i.d.R. nur einmal an einen Kollegen weitergegeben, und dann für immer.

    Lernen von Code: Code wird entweder kopiert und verändert oder selbst geschrieben. Von Code zu lernen ist eklig - bis man kapiert, was der Code macht, hat man schon vergessen, was man eigentlich ursprünglich wissen wollte. 😉



  • Hm das ganze ist wohl abhängig von der Projektgröße, Bei kleinerer Sachen, klar dann macht das einer allein. Aber ab einer gewissen Größe gehts halt nicht mehr. Und wenn man zusammen arbeitet, dann sollte nun mal eine Fornatierungsstandard festgelegt werden, woran sich alle halten müssen. Obs dann einem nicht gefällt ist doch Nebensache und kein Grund, so etwas nicht zu tun.
    Wie gesagt, hängt alles von der Projektgröße ab ... und von der Firma^^



  • Marc++us schrieb:

    Ohne Kontrolle durch einen Leser der Kommentare mit Feedback lernt man doch nicht das Schreiben englischer Kommentare... wo ist nämlich das zum Lerneffekt benötigte Feedback?

    Das Projekt war groß genug und die Kollegen entsprechend ehrlich - man wurde schon korrigiert. 🙂
    Außerdem hatten die meisten wohl schon genug englischsprachige Projekte hinter sich.

    Nur die Analysedokumente waren hin und wieder etwas abenteuerlich, aber die waren ja nicht von uns. 🤡



  • Bayrisch oder Platt.



  • Dipl. Inf. schrieb:

    Bayrisch oder Platt.

    😃 👍



  • poller schrieb:

    in welcher Sprache sollte man seine Dokumentation verfassen?

    kommt auf den code an.

    gute programme haben eh mehrere schichten oder libs. da kannste pro lib ne andere sprache nehmen. hab ich manchmal so gemacht und es führt zu keinen problemen. also ganz unten, wo man von stack und heap redet, von pus, pop, sort, unuque und merge, da ist englisch sehr angebracht.

    weiter oben, wo es um mehrwertsteuer, anderkonto, biersteuer, reichspostgesetz und GEZ geht, ist es unangebracht, ins englische zu gehen, weil man dabei zu viele deutsche wörter zwanghaft englischifizieren muß. oft so, daß der ami sie überhaupt nicht versteht (während er die deutschen versteht oder herausfinden könnte).

    wie immer: alle generalisierungen sind falsch.



  • volkard schrieb:

    wie immer: alle generalisierungen sind falsch.

    Gilt das auch für http://www.c-plusplus.net/forum/viewtopic-var-t-is-123902.html ? 😉



  • Marc++us schrieb:

    Hast Du mal gesehen, in wie vielen "deutschen englischen Kommentaren" fälschlicherweise "actual" als Begriff verwendet wird, weil der Schreiber "aktuell" meint, aber nicht weiß daß er "current" schreiben müßte?

    Letztens erst 'nen Kumpel drauf hingewiesen... 😃 👍

    Geil ist auch:

    eventually != eventuell (sogar quasi schon das Gegenteil) 💡



  • Brr, sowas wie actual statt current und eventually für eventuell versteh ich überhaupt nicht; immerhin gibt es doch in jeder Schule Englischunterricht.

    Wenn es irgendwie möglich ist und auch nur ein bisschen Sinn macht, schreibe ich Kommentare auf Englisch. (Also eigentlich fast immer; muss zum Glück keine Steuersoftware - siehe volkards Post - schreiben.)



  • nman schrieb:

    Brr, sowas wie actual statt current und eventually für eventuell versteh ich überhaupt nicht; immerhin gibt es doch in jeder Schule Englischunterricht.

    Ironie? 😕



  • nman schrieb:

    Brr, sowas wie actual statt current und eventually für eventuell versteh ich überhaupt nicht; immerhin gibt es doch in jeder Schule Englischunterricht.

    Der scheint in A deutlich besser als in D zu sein... 😃



  • ursel schrieb:

    Ironie? 😕

    Was meinst Du?



  • Sgt. Nukem schrieb:

    Der scheint in A deutlich besser als in D zu sein... 😃

    Keine Ahnung, vielleicht.
    Aber wenn man eine Sprache ein Jahrzehnt lang lernt, dann sollte doch zumindest ein bisschen etwas hängen bleiben.


Anmelden zum Antworten