Faculty Standards

Style Guide

How we write — usage, grammar, and a word list adapted from the O’Reilly Style Guide

01 / Good Work · 02 / Best Practices · 03 / Style Guide

We work to better the web for everyone, but much of what we do is invisible. People form opinions and feelings about things they can’t see based on things they can — including our words.

Being consistent with our words helps build trust. These guidelines help us ensure that what we write reflects the same thought and care we put into everything else we do at Faculty.

  1. 01

    Usage and grammar

    • Acronyms. Try not to use them. If you must, provide a definition when you first use one.
    • Contractions. Use them whenever they won’t sacrifice clarity. They generally make copy sound more conversational.
    • Em dashes. Format them with a space on each side — like this. To a browser’s line-breaker, word—word is a single unbreakable token, which can force awkward overflow at narrow widths. Spaces give the line-breaker somewhere to wrap.
    • En dashes. Use to denote a range, such as October 7–9.
    • Jargon. Speak plainly and avoid jargon as much as possible.
    • Numbers. Spell out numbers one through ten. Write higher numbers as digits. For example: use 13, not thirteen. Two exceptions: technical specifications take digits (“8 characters minimum,” not “eight characters minimum”), and related numbers share a format (“one was 8 and the other 13,” not “one was eight and the other 13”).
    • Oxford or serial comma. Use it here, here, and here.
    • Their. Use it as a gender-neutral possessive pronoun.
    • They. Use it as a gender-neutral pronoun to refer to multiple people or just one. For example, “They rode their bike to lunch.” and “They rode their bikes to lunch.” are both correct. (It’s also good to use words like folks or y’all to address groups of people instead of using the gender-specific guys.)
    • Your (not my) is the possessive pronoun we use to describe features or items that belong to a user.
  2. 02

    Website guidelines

    • Use sentence case for all headers and button copy.
    • Use ampersands in headings when space is tight. Otherwise, just use the word and.
    • Use title case only for titles (e.g., the title of a blog post or newsletter).
    • Don’t use terminal punctuation in headers or titles, unless you need a question mark or exclamation point. And if the latter, you probably don’t. The exception: a header that runs to more than one sentence — where the punctuation between sentences forces the issue, and the final one should terminate too.
    • Don’t link terminal punctuation.
    • Ensure linked text describes the result of clicking the link. Ideally, linked text meant to prompt action appears at the end of a sentence, so the reader can take action as soon as they understand the task.
  3. 03

    Word list

    Adapted and extended from the O’Reilly Style Guide, our favorite reference for many years.

    Aa

    • ad hoc
    • AI
    • Ajax
      Ajax is not an acronym.
    • a.k.a.
    • a.m.
    • alt
    • alt + n
    • anti-pattern
    • API
    • app
      In most cases, app is clearer than application when writing about web apps and mobile apps.
    • appendices
    • async
    • autogenerate

    Bb

    • backend
    • backslash \
    • backspace
      Historically the delete key behaves differently than what recent Apple keyboards label delete. Favor clarity.
    • backtick `
    • backup (n)
    • back up (v)
    • backward
    • backward compatible
    • bandwidth
    • bitmap
    • bitmask
    • bitwise operators
    • Boolean
    • braces { }
    • brackets [ ]
    • browsable
    • built-in (a, n)

    Cc

    • caps lock
    • caret ^
    • checkbox
    • checkmark
    • check-in (a, n)
    • check in (v)
    • click-through (a)
    • click through (v)
    • client-side (a)
    • client side (n)
    • coauthor
    • cofounder
    • command
    • command-line (a)
    • command line (n)
    • compile-time (a)
    • compile time (n)
    • control
    • control + alt + delete
    • control + n
    • copyleft
    • copyright
    • copywriting
    • coworker
    • cross-reference
    • CRLF
    • CTA

    Dd

    • database
    • data center
    • data
      Data is singular. If you think data are plural, we hope you also think spaghetti are delicious.
    • decision-making (a)
    • decision making (n)
    • delete
      Make sure you don’t mean backspace.
    • DevOps
    • DNS
    • DOM
    • dot-com (a, n)
    • double click
    • double quotes
    • down arrow
    • download
    • drag-and-drop (a, n)
    • drag and drop (v)
    • dropdown menu

    Ee

    • e.g.
    • ecommerce
    • email
    • end user (n)
    • end-user (a)
    • enter
    • escape
    • et al.
    • ethernet

    Ff

    • fallback
    • failover
    • FAQ
    • filename
    • filesystem
    • foreground
    • foreword
    • forward
      If you mean a short introduction, it’s spelled foreword.
    • frontend
    • full-stack (a)

    Gg

    • G Suite
      This is now called Google Workspace.
    • gateway
    • Gb (gigabit)
    • GB (gigabyte)
    • Gbps (gigabits per second)
    • GHz (gigahertz)
    • GIF or .gif
    • Git or git
      If referring to the actual command, use git, otherwise use Git.
    • Google Workspace
    • gray
      When using American English, gray is how you spell the color. That’s why it’s called Castle Grayskull.
    • grayscale
    • greater-than sign or right angle bracket >
    • GUI, GUIs

    Hh

    • hardcoded
    • hardcode (v)
    • hash or pound sign #
    • high-level (a)
    • home page
    • hostname
    • HTML
    • HTTPS
    • hypertext

    Ii

    • IDs
    • inception
      Avoid using this to mean a thing inside a thing. It means the origin or starting point of something.
    • inline
    • internet, the internet
    • iOS, iOS 13
    • IP
    • IRC
    • ISP

    Jj

    • JavaScript
    • JPEG or .jpeg

    Kk

    • kb (kilobit)
    • kB (kilobyte)
    • kbps (kilobits per second)
    • keepalive (a, n)
    • keystroke
    • keywords

    Ll

    • Lambda
      If referring to Amazon Lambda, it’s a proper noun. Otherwise, use lambda.
    • left angle bracket or less-than sign <
    • life cycle
    • login (a)
    • log in (v)
    • logout (a)
    • log out (v)
    • lowercase

    Mm

    • machine learning (n)
    • machine-learning (a)
    • man page
    • Markdown
    • markup
    • Mb (megabit)
    • MB (megabyte)
    • Mbps (megabits per second)
    • MHz (megahertz)
    • menu bar
    • metadata
    • microservices
    • mobile first (a)

    Nn

    • name server
      Use this instead of DNS server.
    • namespace
    • newline
    • nginx
      The server is called nginx. The company is called NGINX.
    • NoSQL

    Oo

    • object-oriented programming
    • okay
    • offline
    • onboard
    • online
    • open source (a, n)
    • option

    Pp

    • password
    • PDF
    • %
      In most cases, it is unnecessary and less clear to use the word percent.
    • Perl
    • PHP
    • plain text (n)
    • plain-text (a)
    • plug in (v)
    • plug-in (a, n)
    • p.m.
    • PNG
    • pop up (n, v)
    • pop-up (a)
    • post-process
    • private key (n)
    • processor
      In most cases, it is better to avoid jargon like CPU and speak plainly instead.
    • public-key (a)
    • public key (n)
    • Python

    Qq

    • quotes
      It is unnecessary to spell out quotation marks, but do so when clarity would be lost otherwise.

    Rr

    • read-only (a)
    • real time (n)
    • real-time (a)
    • re-create
    • rename
    • resumé
      Although résumé isn’t wrong, that’s not how we pronounce it. Favor clarity.
    • return
    • retweet
    • right angle bracket or greater-than sign >
    • right-click
    • roll back (v)
    • rollback (n)
    • rootkit
    • runtime (a, n)

    Ss

    • scalable
    • screensaver
    • screenshot
    • scroll bar
    • SSH or ssh
      If referring to the actual command, use ssh, otherwise use SSH.
    • SSL
    • self-host, self-hosted, self-hosting
    • semicolon
    • server side (n)
    • server-side (a)
    • service worker
    • set up (v)
    • setup (n)
    • shareable
    • shift
    • shitshow
    • shortcut
    • single quote
    • sitemap
    • source code
    • space bar
    • spell check
    • split screen
    • standalone
    • stateful
    • stateless
    • status bar
    • stylesheet
    • sync

    Tt

    • t-shirt
    • tab
    • TCP/IP
    • TB (terabyte)
    • text box
    • thumbs up, thumbs down
    • timestamp
    • time zone
    • title bar
    • TLS
      Use this instead of SSL, unless you’re writing about the past.
    • toolbar
    • toolchain
    • toolkit
    • tooltip
    • top-level (a)
    • toward
    • trade-off
    • troubleshoot
    • tweet

    Uu

    • UK (United Kingdom)
    • Unix
    • uppercase
    • up-to-date
    • URLs
    • US (United States)
    • username

    Vv

    • versus or vs.
    • vice versa

    Ww

    • web
    • web client
    • web page
    • web server
    • webhook
    • website
    • whitepaper
    • whitespace
    • WiFi
    • wildcard
    • wireframe
    • workaround
    • workstation
    • wraparound
    • writable
    • write-only (a)
    • WYSIWYG

    Xx

    • XML

    Zz

    • zeroes or 0s
    • ZIP code
      ZIP is an acronym for Zone Improvement Plan. We’re big fans of the USPS, and we want to be respectful of their terminology.
    • zip (v)
    • ZIP or .zip

Colophon

Style Guide is the third of three small guides on the virtual studio shelf, alongside Good Work and Best Practices.

Set in Mallory by Frere-Jones Type, with marginalia in Pitch Sans by Klim Type Foundry.