Style guide

This style guide explains our guidelines for contributions to SucuriLabs’s docs, tutorials, newsletters, blog posts, and content in general.

General principles

Assume almost nothing

As you gain mastery of a product or feature, some things become second nature, but remember they weren’t always so obvious. Call these out, an provide links to relevant docs or websites.

Make it easy for your reader to solve their issue, whether they are an expert or just starting out with SucuriLabs.

Get to the point

If you’re explaining something, don’t wait three paragraphs to do so. Start with the explanation and expand later. Allmost all articles can be improved by shortening (or removing) the intro.

Don’t try to be clever. And don’t be boring.

Make it easy to read

Most readers will scan a page before committing to reading it. They’re looking for signs it’ll answer their question(s) and quality.

Use clear headings, diagram and tables to demonstrate thoroughness.

Avoid hedging

We are opinionated at SucuriLabs. That means avoiding being vague like saying “it’s complicated” or “it depends”. This is frustating for the reader and doesn’t add value. Instead:

Have an opinion;
Provide an example;
Do the research until you can do point one or point two.

Style rules

Use American English

Although SucuriLabs is an european company. We want to reach readers distributed around the world. For consistency, we use American English spelling, and grammar. For date and time formatting, we use YYYY-mm-dd and HH:MM:ss (i.e 2026-12-31 23:59:59). It’s preferable to use UTC+00 as our timezone.

Use sentence case for titles

Write “Documentation style guide”, not “Documentation Style Guide” and “SucuriLabs has triage and investigation tools”, not “SucuriLabs has Triage and Investigation Tools”.