Angenommen, Sie möchten über eine Befehlszeilensoftware wie makeoder bashoder den cpBefehl sprechen. Diese Befehle sind alle in Kleinbuchstaben geschrieben und unterscheiden zwischen Groß- und Kleinschreibung (dh sie funktionieren auf dem Computer nicht, wenn Sie sie groß schreiben) und sind oft auch die Namen der Softwareprojekte, die die Programme schreiben, die die Befehle aufrufen. Was passiert, wenn Sie einen Satz mit dem Namen eines dieser Tools beginnen möchten? Welche der folgenden ist am besten?
catist ein Unix-Dienstprogramm zum Verketten von Dateien. (Beginne den Satz mit einem dieser seltsamen Codebox-Dinge. Erfordert, dass diese Formatierungsoption verfügbar ist, und du beginnst immer noch mit einem Kleinbuchstaben.)Behandeln irgendwelche Styleguides dieses Problem?
Regel Nr. 1 in der Technischen Dokumentation lautet: Führen Sie den Leser nicht in die Irre. Wenn der Befehls- oder Funktionsname mit einem Kleinbuchstaben beginnt, ist die Großschreibung ein Fehler – es ist nicht „Cat“, sondern „cat“. Das Microsoft Manual of Style legt fest, dass wörtliche Elemente wie dieses mit ihrer korrekten Groß- und Kleinschreibung geschrieben werden sollten. Es erfordert auch die Verwendung von Textstilen, um sie auszugleichen, ebenso wie andere Stilrichtlinien, die ich verwendet habe. (Microsoft bevorzugt Fettdruck; andere bevorzugen Monospace.)
Überraschenderweise gehen softwareorientierte Styleguides meiner Erfahrung nach nicht auf den speziellen Fall ein, einen Satz mit diesen Elementen zu beginnen. Wenn Sie das Problem umgehen können, ohne die Dokumentation umständlicher zu machen, habe ich festgestellt, dass es am besten ist, dies zu tun. Anstatt von
catist ein Unix-Dienstprogramm zum Verketten von Dateien.
Vielleicht kannst du schreiben
Wird verwendet
cat, um Dateien zu verketten.
Du könntest schreiben
Das
catDienstprogramm verkettet Dateien.
Dies kann jedoch schnell entweder umständlich oder widersprüchlich werden – wenn Sie catan manchen Stellen „der Nutzen“ sagen, catan anderen jedoch „ “, fragen sich die Leser, warum. Wenn Sie jedoch überall die erstgenannte Formation verwenden, erschweren Sie das Scannen der Dokumentation und fügen scheinbar unnötig zusätzliche Wörter hinzu.
Die Software-Dokumentationsteams, denen ich in den letzten 20 Jahren angehörte, haben alle diese Richtlinie befolgt: Schreiben Sie um das Problem herum, wenn Sie dies vernünftigerweise tun können, und wenn Sie dies nicht können, beginnen Sie den Satz einfach mit dem Kleinbuchstaben . Die Verwendung von Textstilen für Befehls-/Funktions-/etc-Namen mildert den Großschreibungs-"Fehler".
Die GNU-Site selbst behandelt den Namen des Make-Dienstprogramms als Wort in Großbuchstaben: https://www.gnu.org/software/make/
Es scheint eine Konvention zu geben, häufig make(den Befehl) zu verwenden, wo Make (der Name) angemessener erscheint. Das GNU Make-Handbuch scheint dies fast ausschließlich zu tun ( https://www.gnu.org/software/make/manual/make.html ), aber immer mit einer Schriftartänderung, um anzuzeigen, dass es sich um den verwendeten Befehl handelt.
Diese Beispiele würden also die zweite und dritte Option für Make rechtfertigen, obwohl das Handbuch die Verwendung makeam Anfang eines Satzes zu vermeiden scheint.
Es ist jedoch weniger klar, dass cpoder catauf diese Weise behandelt werden kann. Sie sind mehr Befehle als eigenständige Produkte wie Make. Ich würde es vermeiden, sie als eigenständige Namen zu verwenden, und stattdessen "The catcommand" wie in:
Der
catBefehl wird verwendet, um Dateien zu verketten.
catverkettet Dateien. 2. Verwenden Sie catzum Verketten von Dateien.
raddevus