Skip to main content
Themen

Blick über den Tellerrand

By 29. März 2022Mai 23rd, 2022No Comments

Themen

Blick über den Tellerrand

29.03.2022

Manchmal lohnt sich der Blick über den Tellerrand, in diesem Fall über den Rand der Reisschüssel. Was wir da sehen, ist ein Styleguide für technische Dokumente in Chinesisch und für Chinesisch.

Dieser Styleguide regelt einen chinesischen Schreibstil, der in erster Linie für das Verfassen von technischen Dokumentationen verwendet wird. Das Material zielt darauf ab, Referenzspezifikationen für den Sprachstil, den Strukturstil, die Inhaltselemente, die Interpunktion, das Format und den Satz chinesischer technischer Dokumente zu geben.

Insgesamt fallen mir sogar gleich 3 gute Gründe für den etwas anderen Horizont dieses Styleguides ein:

  • Der Inhalt des Styleguides
    Der Styleguide ist einen Open-Source-Information für das Verfassen chinesischer technischer Dokumente.
  • Das Hosting des Styleguides
    Der Styleguide und seine Versionen werden auf GitHub gehostet.
  • Das Authoring des Styleguides
    Sphinx, der Python Dokumentation Generator, ist das Tool zum Erstellen des Styleguides.

Als Technischer Redakteur war mein erster Blick natürlich auf den Inhalt des Styleguides gerichtet. Aber tatsächlich interessant ist hier die Umsetzung als Docs-as-Code. Nehmen Sie sich doch auch etwas Zeit und die Übersetzungsfunktion Ihres Browsers, um etwas durch den Styleguide zu surfen.

Aber tatsächlich interessant ist hier die Umsetzung als Docs-as-Code.

Marco Jänicke