Diskussion:Guter Stil: Unterschied zwischen den Versionen
(Sektion "Mitglieder/Kunden von Resellern" eingefügt) |
("Für wen schreiben wir" -- zum Warum und Wie der technischen Dokumentation) |
||
Zeile 32: | Zeile 32: | ||
Wie in der Umfrage oben ausgeführt, denke ich auch an die Kunden von Resellern, für die die Doku bestimmt ist. Dort kann sich vielleicht nicht jeder mit dem "Du" anfreunden. Auf der anderen Seite ist die Doku für diesen Personenkreis ohnehin etwas kryptisch. Wäre es nicht sinnvoll, für diese Personen einen eigenen Bereich zu haben, der ausschließlich auf die speziellen Belange eingeht? (Muss ja nicht sofort sein). | Wie in der Umfrage oben ausgeführt, denke ich auch an die Kunden von Resellern, für die die Doku bestimmt ist. Dort kann sich vielleicht nicht jeder mit dem "Du" anfreunden. Auf der anderen Seite ist die Doku für diesen Personenkreis ohnehin etwas kryptisch. Wäre es nicht sinnvoll, für diese Personen einen eigenen Bereich zu haben, der ausschließlich auf die speziellen Belange eingeht? (Muss ja nicht sofort sein). | ||
--[[Benutzer:Jsc00-wiki|Jsc00-wiki]] 09:07, 24. Mai 2009 (UTC) | --[[Benutzer:Jsc00-wiki|Jsc00-wiki]] 09:07, 24. Mai 2009 (UTC) | ||
== Für wen wir schreiben == | |||
"Du" ist nicht nur der Mitgenosse, sondern schließlich jeder, der bei IKEA einkauft, also was soll's. Anstatt einen eignen "Sie"-Bereich aufzumachen, sollten wir uns einfach bewußt machen -- um die Doku verständlicher und damit nützlicher zu machen als bisher -- daß wir für verschiedene Personenkreise schreiben. Und zwar, in einer gewissen Reihenfolge: | |||
Ich schreibe für: | |||
- mich selbst. Mir ist sind Stil, Grammatik, Satzbau, Zeichensetzung Rechtschreibung, konsistente und genaue Terminologie, und logische Gliederung vollkommen wurscht, denn ich weiß schon so, was die Seite sagen will. | |||
- technisch versierte System-Admins. Sie verstehen genauso wie ich, daß ich mit einem einzelnen, grammatikalisch völlig losgelösten Stichwort in runden Klammern eine ganze Reihe von Operationen meine, und führt diese mitdenkend aus. | |||
- Paket-Admins mit langjähriger HS-Erfahrung. Sie wissen nicht nur, wie alles hier läuft, sondern auch, wie es früher war. Sie wissen sofort, was eine "aufgesetzte Domain" oder ein "Domain-Robot" ist. | |||
- Neue Paket-Admins. <ironie>Mein Gott, die nerven. Denen muß man alles erklären! Können wir nicht irgendwie dafür sorgen, daß nur technisch versierte System-Admins (siehe oben) zu Hostsharing kommen? Oder mindestens Leute, die einen gelinkten HS-Begriff anklicken können, um sich selbst unser Jargon zu erarbeiten?</ironie> | |||
- Domain-Admins. Wie Paket-Admins bringen sie mehr oder weniger Webmasterei-Grips mit. | |||
- Und so weiter bis zum völlig unbeleckten und leider Gottes auch noch etwas begriffsstutzigen Reseller-Endkunden. | |||
Kurz: Laßt uns doch, im Ggs zur alten HS-Doku, für den interessierten Leser schreiben, der kein Gedankenleser ist, auch wenn er Allgemeinbildung, Wohlwollen und durchschnittliche Intelligenz mitbringt. Schreiben wir ganze Sätze; überlegen wir uns, wie etwas korrekt zu bezeichnen ist; bleiben wir bei der gewählten Bezeichnung; setzen wir nicht voraus, daß der Leser schon die ganze Struktur des Dateisystems inklusive Permissions kennt. Gliedern wir die Anleitungen in der chronologischen Reihenfolge der Arbeitsschritte; gliedern wir die Softwarebeschreibungen so, daß die Optionen erklärt werden, bevor sie in Beispielen verwendet werden. Erklären wir die grundlegenden Strukturen am Anfang einer Beschreibung, nicht erst am Ende. | |||
Darf ich etwas davon in die "Guter Stil"-Seite aufnehmen? | |||
[[Benutzer:Apc00-tony|Apc00-tony]] 11:06, 17. Jun. 2009 (UTC) |
Version vom 17. Juni 2009, 11:06 Uhr
Anrede des Lesers
Im Text steht momentan: "Sie ist wenn möglich in der zweiten oder dritten Person geschrieben, damit andere leichter an der Seite weiterarbeiten können."
Das finde ich etwas unklar bzw. nicht ausreichend. Erstens gibt es zwei Personen, von denen man in einem Artikel häufig sprechen wird: Hostsharing und den Leser. Von Hostsharing können wir meiner Meinung nach sowohl in der ersten Person Plural sprechen ("Wir bieten die Möglichkeit, ...") als auch in der dritten Person ("Hostsharing bietet die Möglichkeit, ..."). Je nachdem, was stilistisch besser passt, sollte der Autor die passende Form wählen.
Bei der Ansprache des Lesers gibt es schon ein paar mehr Möglichkeiten:
- Erste Person Plural ("Autor-und-Leser-Wir"), zum Beispiel: "Um einen neuen Benutzer anzulegen, geben wir auf der Kommandozeile xyz ein."). Nachteil: Gefahr der Verwechslung mit dem Wir, das sich (nur) auf Hostsharing bezieht; Gefahr, dass die Formulierung den Leser vereinnahmt.
- Zweite Person Du: "Um einen neuen Benutzer anzulegen, gibst Du auf der Kommandozeile xyz ein". Vorteil: entspricht dem üblichen Schreibstil auf unseren Mailinglisten. Nachteil: manche Anwender möchten nicht geduzt werden, die Dokumentation ist für Reseller nicht direkt verwendbar.
- Zweite Person Sie: "Um einen neuen Benutzer anzulegen, geben Sie auf der Kommandozeile xyz ein". Vorteil/Nachteil genau umgekehrt zum Du.
- Dritte Person: "Um einen neuen Benutzer anzulegen, gibt {man | der Paketadmin} auf der Kommandozeile xyz ein". Vorteil: neutral, Nachteil: unpersönlich.
Momentan werden in der Dokumentation alle diese Formen (außer "Sie") verwendet, teilweise sogar alle innerhalb eines Artikels, außerdem ziemlich häufig das Passiv. Ich denke, dass wir uns zumindest zwischen Wir, Du und Sie als Ansprache für den Leser entscheiden sollten, oder ganz auf die dritte Person beschränken. Oder wir legen uns nicht fest und halten es nur innerhalb eines Artikels konsistent.
Ich neige momentan dazu, das Du zu bevorzugen (plus Dritte Person und Passiv bei Bedarf).
Meinungen dazu?
--Jrs00-wiki 23:18, 20. Feb. 2009 (UTC)
Unter uns ist das kein Problem. Die Doku soll aber auch Kunden von Resellern dienen, zumindest teilweise. Da hielte ich das "Sie" für angebrachter.
--Jsc00-wiki 09:03, 24. Mai 2009 (UTC)
Das Durcheinander...
...kommt von der derzeitigen Übernahme aus der Dokumentation. Solange es diese betrifft, bin ich für "Du", denn es passt besser zu uns. "Du" ist auch in vielen Firmen Standard und es ist einfach freundlicher, es sitzt ja praktisch immer eine einzelne Person als Leser vor dem Screen, das ist eine intime Situation, in der die Person Rat sucht. Also die persönlich Ansprache mit "Du" halte ich daher für sehr geeignet - besonders, wenn es um Handlungsanweisungen geht. Dazu ist es geschlechtsneutral. --ChristofT 04:33, 21. Feb. 2009 (UTC)
Mitglieder/Kunden von Resellern
Wie in der Umfrage oben ausgeführt, denke ich auch an die Kunden von Resellern, für die die Doku bestimmt ist. Dort kann sich vielleicht nicht jeder mit dem "Du" anfreunden. Auf der anderen Seite ist die Doku für diesen Personenkreis ohnehin etwas kryptisch. Wäre es nicht sinnvoll, für diese Personen einen eigenen Bereich zu haben, der ausschließlich auf die speziellen Belange eingeht? (Muss ja nicht sofort sein). --Jsc00-wiki 09:07, 24. Mai 2009 (UTC)
Für wen wir schreiben
"Du" ist nicht nur der Mitgenosse, sondern schließlich jeder, der bei IKEA einkauft, also was soll's. Anstatt einen eignen "Sie"-Bereich aufzumachen, sollten wir uns einfach bewußt machen -- um die Doku verständlicher und damit nützlicher zu machen als bisher -- daß wir für verschiedene Personenkreise schreiben. Und zwar, in einer gewissen Reihenfolge:
Ich schreibe für:
- mich selbst. Mir ist sind Stil, Grammatik, Satzbau, Zeichensetzung Rechtschreibung, konsistente und genaue Terminologie, und logische Gliederung vollkommen wurscht, denn ich weiß schon so, was die Seite sagen will.
- technisch versierte System-Admins. Sie verstehen genauso wie ich, daß ich mit einem einzelnen, grammatikalisch völlig losgelösten Stichwort in runden Klammern eine ganze Reihe von Operationen meine, und führt diese mitdenkend aus.
- Paket-Admins mit langjähriger HS-Erfahrung. Sie wissen nicht nur, wie alles hier läuft, sondern auch, wie es früher war. Sie wissen sofort, was eine "aufgesetzte Domain" oder ein "Domain-Robot" ist.
- Neue Paket-Admins. <ironie>Mein Gott, die nerven. Denen muß man alles erklären! Können wir nicht irgendwie dafür sorgen, daß nur technisch versierte System-Admins (siehe oben) zu Hostsharing kommen? Oder mindestens Leute, die einen gelinkten HS-Begriff anklicken können, um sich selbst unser Jargon zu erarbeiten?</ironie>
- Domain-Admins. Wie Paket-Admins bringen sie mehr oder weniger Webmasterei-Grips mit.
- Und so weiter bis zum völlig unbeleckten und leider Gottes auch noch etwas begriffsstutzigen Reseller-Endkunden.
Kurz: Laßt uns doch, im Ggs zur alten HS-Doku, für den interessierten Leser schreiben, der kein Gedankenleser ist, auch wenn er Allgemeinbildung, Wohlwollen und durchschnittliche Intelligenz mitbringt. Schreiben wir ganze Sätze; überlegen wir uns, wie etwas korrekt zu bezeichnen ist; bleiben wir bei der gewählten Bezeichnung; setzen wir nicht voraus, daß der Leser schon die ganze Struktur des Dateisystems inklusive Permissions kennt. Gliedern wir die Anleitungen in der chronologischen Reihenfolge der Arbeitsschritte; gliedern wir die Softwarebeschreibungen so, daß die Optionen erklärt werden, bevor sie in Beispielen verwendet werden. Erklären wir die grundlegenden Strukturen am Anfang einer Beschreibung, nicht erst am Ende.
Darf ich etwas davon in die "Guter Stil"-Seite aufnehmen?
Apc00-tony 11:06, 17. Jun. 2009 (UTC)