Guidelines ZMB Guides

On this page we collect basic rules, standards and recommendations for writing ZMB guides.

Please inform Joana if you think that something is not clear or missing.

• Only include information that is absolutely essential for solving the described task.
• In the "Introduction" section of a guide always give a short summary of the content/learning outcome.
• Do not use "Prerequisite guides".
• When using abbreviations, introduce them using brackets.

• Do not use multiple spaces or tabs to format/structure your text.
• Only use capital letters
  • at the beginning of a sentence.
  • after a colon or semicolon.
  • in the guide title.
• If you refer to a software window or button write the text exactly as in the window/button and put it between quotation marks (e.g. "Start"). This includes use of capital letters.
• End bullet sentences with a point.

We use tags to automatically group guides for the different instruments.

• Do not add tags without checking with either Joana . They will make sure your guide has the proper tag once you send it for revision.
• Please let us know if a tag is missing.

For ordering guides within an instrument section (either according to their relevance or sequential order) use the following naming scheme in the title:

[Instrument] - 1: [Guide Title]

• Screen to GIF is installed in all instruments. It is useful to capture your snapshots.
• Make sure your images/screenshots focus on the essential aspects of a task.
• Use the Dozuki crop function to reduce "dead space". It is not helpful if the user has an overview of the screen, but can't read what he/she should actually click.
• Images/screenshots should be clearly visible on mobile devices.
• The minimum required resolution is 800x600px. Set the Screen to GIF window to this size. This will show how much can you zoom in or crop your image.
• People will focus on the 1st image and fly through the 2nd and 3rd. If your 3rd image is crucial for the workflow add it as an extra step.

Please also collect your pictures/screenshots on our file server:

"Z:\zmboffice\Teaching\Dozuki"

They can be used in other guides or scripts.

• Do not publish guides by yourself. Depending on the topic inform Urs, Andres or Joana when ready for review.