Skip to main content
Topics

Looking beyond the rim of the plate

By 29. March 2022No Comments

Topics

Looking beyond the rim of the plate

2022-03-29

Sometimes it pays to think outside the box, in this case, outside the rice bowl. What we see there is a style guide for technical documents in Chinese and for Chinese.

This style guide specifies a Chinese writing style that is primarily used for writing technical documentation. The material aims to provide reference specifications for the language style, structure style, content elements, punctuation, format and typesetting of Chinese technical documents.

All in all, I can think of 3 good reasons for the somewhat different horizon of this style guide:

  • The content of the style guide
    The style guide is an open source information for writing Chinese technical documents.
  • Hosting of the style guide
    The style guide and its versions are hosted on GitHub.
  • The authoring of the style guide
    Sphinx, the Python documentation generator, is the tool used to create the style guide.

As a technical writer, my first look was of course at the content of the style guide. But actually, interesting here is the implementation as docs-as-code. Why don’t you also take some time and the translation function of your browser to surf a bit through the style guide.

But actually, interesting here is the implementation as docs-as-code.

Marco Jänicke
Print Friendly, PDF & Email
Close Menu