---
# System prepended metadata

title: Docs Guidelines
tags: [Docs Guidelines]

---

## Punctuation and Misc

- Use Oxford commas: "first, second<strong>,</strong> and third" vs "first, second and third". Oxford commas should also be used with the conjunction "or".
- Generally, numbers less than eleven should be spelled out: "... nine, ten", but "11...".


## Acronyms

The many new Endgame entities are commonly referred to through their acronyms. These can be opaque for the occasional reader. To spare them (the readers) from hunting down the meaning of the acronyms, use the HTML `abbr` tag.

### Usage

`<abbr title="Aligned Voter Committee">AVC</abbr>`

*Rendered as*: <abbr title="Aligned Voter Committee">AVC</abbr>

### Tips

- Plain replacement is enough:
    1. Look up the acronym you want to wrap inside the `abbr` tag. To be safe, use <abbr title="Regular Expressions">RegEx</abbr>: If you are looking up the <abbr title="Aligned Conserver">AC</abbr> acronym, use `\bAC`, which will ensure that you are not matching "FAC" in "50/50 FAC/MKR".
    3. Replace it with `<abbr title="[expanded acronym]">acronym</abbr>`
- The <abbr title="Regular Expressions">RegEx</abbr> `[A-Z]{2,}` picks up strings that look like acronyms --- specifically, strings that are at least two characters long and all-caps. This makes it easier to check that no acronym within a document has been overlooked.
- (I'm not sure whether to use different forms for singular and plural instances --- e.g., should it be <abbr title="Aligned Conserver">AC</abbr> and <abbr title="Aligned ConserverS">ACs</abbr>? Plural should be the default and only form, probably.)