Writing style
Companion Intelligence docs follow the Google developer documentation style guide .
Must follow
- Second person (“you”) for instructions
- Active voice and present tense for product behavior
- Sentence case for titles and headings
- Serial commas
- Descriptive link text (not “click here” or “this page”)
- Conditions before instructions
Avoid
- “In this guide, we will…” openings
- Softeners in procedures (“simply”, “just”, “easily”)
- Cheerleading (“Congratulations!”, “Sure!”)
- “Please note”
- Exclamation points in technical prose
- Unexplained jargon; define Hub, CI Account / Portal, and Companion Memory on first use when the audience may be new
Before and after
Each row applies one rule from the lists above.
| Instead of | Write | Rule |
|---|---|---|
| In this guide, we will check the Hub status. | Check the Hub status. | Second person; no “we will” openings |
| The container is started by Hub. | Hub starts the container. | Active voice, present tense |
Simply run cihub status. | Run cihub status. | No softeners in procedures |
| Click here for the CLI reference. | See the CLI reference. | Descriptive link text |
Run cihub up if Docker is running. | If Docker is running, run cihub up. | Conditions before instructions |
| Running Locally | Running locally | Sentence case for headings |
Product names
| Name | Use for |
|---|---|
| Companion Hub | This appliance runtime and dashboard |
| CI Account | Account and device flows at hub.ci.computer |
| Companion Portal | The cloud control plane behind CI Account when you need the engineering name |
| Companion Memory | The personal memory product (not “CI-Server” in user docs) |
Keep legacy Tipi / Runtipi names only in migration or compatibility notes.
Last updated on