Tech Writing Cheat Sheet

Proposed Editorial Style Guide: Google Style Guide

Voice

Second person, active voice, American spelling & punctuation
Address the user as “you”.

Company & Product Names

Camunda
Camunda Cloud
Camunda BPM

Button names

Verb + Button Name
Click OK.

Can use screenshot or icon in instructions.

Text box & text to input

Name is bold, input is code font.
In the Name box enter project1.

Images

All images should include alt text
If using a screenshot to show steps to fill out a UI, include text above or below the screenshot that include input text.

Filenames

Code font, lower case

Menu bar

File and filepath should be bold.
In the File menu, click Save As.
Go to File > New File > BPMN Diagram.