Writing Style Guide

Consistency in writing style ensures a seamless reading experience.

Tone and Voice

• Professional and Friendly: Write in a way that's approachable yet authoritative.
• Clarity: Use simple language to explain complex concepts.

Formatting

• Headings: Use # for main titles, ## for sections, and ### for subsections.
• Paragraphs: Keep paragraphs short for readability.
• Lists: Use bullet points or numbers for lists.
• Code Blocks: Use backticks for inline code and triple backticks for code blocks.

Page heading and title

The website shows the full breadcrumb and sidebar for every page, so the heading should name only the page's own topic — never repeat a parent category.

• # heading (H1): the page's own concept, as it reads after the breadcrumb. Under .../injection/command/argument/, write # Parameter manipulation, not # Argument injection / parameter manipulation. Under .../database/orm/django-orm/, write # Raw SQL injection, not # Django raw SQL injection.
• Frontmatter title: this is the SEO <title> (used by search engines and link previews), not the on-page heading. Keep it descriptive and keyword-rich — it may include the framework or category (e.g. Django ORM raw SQL injection: raw() and cursor string building).

Language Guidelines

• Terminology: Use standard cybersecurity terms.
• Acronyms: Define acronyms upon first use.
• Grammar and Spelling: Use American English spelling and grammar rules.
• No em dashes: Do not use em dashes (—) in prose. Use commas, parentheses, colons, or separate sentences instead. Em dashes are allowed only inside code or payloads when syntactically required.
• No CVE identifiers: Teach the vulnerability class and the affected API or behavior, not specific CVE-YYYY-NNNNN references.

Accessibility

• Alt Text for Images: Provide descriptive alt text.
• Link Text: Use meaningful link text that describes the linked content.

---

Adhering to this style guide helps us deliver clear and consistent content to our readers.