Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

jede Menge Korrekturen, einige Verbesserungen im Sprachstil. #200

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

westhand
Copy link

@westhand westhand commented Oct 9, 2023

Satz von verschiedenen Arten, Code zu setzen.
RFC: wie sehen die anderen das?

Satz von verschiedenen Arten, Code zu setzen.
RFC: wie sehen die anderen das?
@westhand
Copy link
Author

westhand commented Oct 9, 2023

Die Doku ist ja nicht gerade einheitlich formatiert. Ich habe normalerweise nur Dinge angefasst, fuer die es unterschiedliche Faelle gab, die aber einheitlich sein sollten. Dinge, die mir einfallen, die vielleicht anders gewuenscht sind:

  • Anfuehrungszeichen um Monospace: Anfuehrungszeichen entfernt.

Ich finde die Handhabung von <productname> etwas fragwuerdig. Ich habe es schnell aufgegeben, all das nachzutragen, was fehlt. So habe ich z.B. keine eingetragene Marke zu Postfix gefunden, es wird aber als TM markiert, und andersherum haben wir keinerlei solche Markierungen bei Postgres, Linux, jeglichen Distrubutionen oder curl.

Nirgendwo sehe ich den Eindruck, dass wir Teil dieser Produkte sind, sie vertreiben oder dass sie uns gehoeren. Debian ist einst gegen debian-multimedia.org aktiv geworden, weil sie fanden, dass der Eindruck entstand, dass es ein offizielles Debian-Repository war. In unserer Dokumentation steht fast immer explizit, dass die Drittsoftware von woanders bezogen werden muss.

Ich finde so etwas analog zum Bild- oder Quellennachweis hilfreicher. Also eine Fusznote bei der ersten Erwaehnung und ein autogernerierter Anhang aller verwendeten Quellen am Schluss.

@wernerhahn
Copy link
Contributor

Moin,
Du müsstest erstmal nochmal die xml mit dem aktuellem master mergen und die Dateien pdf's und html neu generieren lassen.
Ich hab mir mal das PDF angeschaut.
Code sollte einheitlich gesetzt werden z.B. bei den benötigten Paketen
Der Link ins Kundenforum unter aktuelle Hinweise kann raus, das Forum ist tot.
Bei der Installation. Die hast du ja schon in der Reihenfolge (Git und tgz) geändert. Super. Hier pass doch bitte noch an das es deutlicher wird: Git Installation oder Archiv Installation und hier geht es weiter.
Der Text der Gitinstallation geht über den Rand hinaus.
Ebenso in Kapitel 3.10.1 Zugferd
Fußnote und Quellennachweis wie du oben beschrieben hast ist super.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants