About the Editorial Guide #
The editorial guidelines of Theobald software are a set of recommendations for writing online help content of Theobald Software products. The guidelines are not binding rules, but serve to improve quality of the content of the online help.
The editorial guidelines consist of the following parts:
- Style guide
- Document template
- Conventions for creating screenshots
- Editorial processes - visualised
- Review Process using Fork
Example Values for Online Help Content #
It is recommended to use the following example values when creating content for consistency and security reasons.
Host Names
- sap-erp-as05.example.com
- mssql42.example.com
- oracle23.example.com
Usernames
- Alice
- Bob
- Carol
- J. Random User
Numbers
5, 23, 42, 1337
Generic Strings
Foo, Bar, Baz, Qux