Skip to content
Faculty

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.

We’ve created this guide to help us ensure that what we write reflects the same thought and care we put into everything else we do at Faculty. Being consistent with our words helps build trust.

That said, these are guidelines, not rules, and they’re not comprehensive. We’ll document changes and additions as we learn and grow. This is primarily for our own use at Faculty, but if it’s useful to you, please adopt as you see fit.

Last updated: 07 Oct 2020

Usage and grammar

These guidelines serve as a baseline for all our work, but in particular for Faculty communications, including this website and our newsletter.

  • 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 : If you use them, format them—like this—with no spaces on either side.
  • 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.
  • 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.

Website guidelines

These guidelines apply specifically to websites.

  • 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.
  • 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.

Word list

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

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
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)
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
copyleft
copyright
copywriting
coworker
cross-reference
CRLF
control
control + alt + delete
control + n
CTA
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
e.g.
ecommerce
email
end user (n)
end-user (a)
enter
escape
et al.
ethernet
fallback
failover
FAQ
filename
filesystem
foreground
foreword
forward
If you mean a short introduction, it’s spelled foreword.
frontend
full-stack (a)
G Suite
This is now called Google Workspace.
gateway
Git
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
hardcoded
hardcode (v)
hash or pound sign #
high-level (a)
home page
hostname
HTML
HTTPS
hypertext
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
JavaScript
JPEG or .jpeg
kb (kilobit)
kB (kilobyte)
kbps (kilobits per second)
keepalive (a, n)
keystroke
keywords
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
machine learning (n)
machine-learning (a)
man page
Markdown
markup
Mb (megabit)
MB (megabyte)
Mbps (megabits per second)
menu bar
metadata
MHz (megahertz)
microservices
mobile first (a)
name server
Use this instead of DNS server.
namespace
newline
nginx
The server is called nginx. The company is called NGINX.
NoSQL
object-oriented programming
okay
offline
onboard
online
open source (a, n)
option
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
quotes
It is unnecessary to spell out quotation marks, but do so when clarity would be lost otherwise.
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)
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
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
UK (United Kingdom)
Unix
uppercase
up-to-date
URLs
US (United States)
username
versus or vs.
vice versa
web
web client
web page
web server
webhook
website
whitepaper
whitespace
WiFi
wildcard
wireframe
workaround
workstation
wraparound
writable
write-only (a)
WYSIWYG
XML
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

Contact

Faculty is a friendly, experienced team here to help you with digital strategy, design, and development. We’d love to hear about your project.

Send us a message and let us know how we can help.

[email protected]