-
Notifications
You must be signed in to change notification settings - Fork 1
Writing Style Guide
FAK edited this page Nov 13, 2024
·
1 revision
Consistency in writing style ensures a seamless reading experience.
- Professional and Friendly: Write in a way that's approachable yet authoritative.
- Clarity: Use simple language to explain complex concepts.
-
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.
- Terminology: Use standard cybersecurity terms.
- Acronyms: Define acronyms upon first use.
- Grammar and Spelling: Use American English spelling and grammar rules.
- 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.