Skip to content

F5Docs/style-guide

Repository files navigation

F5 Technical Writing Style Guide

A consolidated reference for F5 technical writers covering voice and tone, formatting, punctuation, procedures, terminology, and accessibility.

Purpose

This guide consolidates F5's previously siloed style guides — Modern Voice, Brand, NGINX, and the F5 Technical Style Guide — into a single, authoritative reference. It is also configured as a knowledge base for the F5 Style GPT agent.

How to use this guide

Each guideline lives in its own file, organized by category. See TOC.md for the full list of topics.

When this guide doesn't cover a topic, consult the fallback guides in this order:

  1. Microsoft Style Guide
  2. Chicago Manual of Style
  3. American Heritage Dictionary (spelling reference)

Language and spelling

This guide follows American English spelling and conventions throughout. Use the American Heritage Dictionary as the spelling reference when in doubt.

Examples of American English preferences:

  • organize, not organise
  • color, not colour
  • license (noun and verb), not licence
  • canceled, not cancelled

Date and time formats

Follow American date format conventions. See Dates and times for full guidance.

  • Dates: June 17, 2026 (not 17 June 2026)
  • Times: 10 a.m. PT (not 10AM or 10:00 AM)
  • Availability: 24x7 (not 24/7)

Contributing

See CONTRIBUTING.md for guidance on adding or updating guidelines. Use the template in templates/guideline-template.md for all new files.

About

F5 Docs Style Guide

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors