This style guide is aimed at n8n technical writers and external content contributors to the n8n blog. You should read it before writing your first article and review it whenever you're in doubt.
<aside>
🚧 Last updated: 18 November 2022
</aside>
General guidelines
- The content should not overly promote a product or service.
- The content should not contain any affiliate links or links to irrelevant sources.
- Use present tense, active voice, and "you"-form to address the readers.
- Keep your writing as concise as possible. Hemingway is a free browser app to measure language complexity. There is no fixed rule about what grade to aim for, but the lower the reading grade, the better.
- The content should be unique and not have been published elsewhere.
- We will not repost content that you have already published on your blog, for example. However, if you want to cross-post the guest post that you wrote for us, you are free to do so, as long as you add the canonical link of the original n8n blog post.
- The tone of voice: convincing, enthusiastic, conversational
Text formatting
- Headings: sentence case (more info)
- UI elements: bold (more info)
- User input: bold, with italics for placeholders (see User input part way down this page for more info)
- File names, directory names, and paths: code formatted.
- Make sure you match brand names precisely. For example: "GitHub", not "Github".
- Numbers: Write zero to nine in letters, 10 and above in numerals (More info)
Graphics
Screenshots of workflows (for tutorials):
- Screenshots of workflows should not include the editor UI (border and buttons).
- Please do not include nodes that aren’t in use. If you aren’t using the Start node, make sure it isn’t in the screenshot.