---
Title: MOM Style Guide
---

# MOM Style Guide

## Motivation

This style guide aims to structure current and future efforts of maintenance and expansion of the MOM. It lays down some basic and well-established conventions --- some of them shared by the broad MakerDAO ecosystem, some unique to the MOM.

## Index

- MOM Target Readership
- General Recommendations
- Markdown

## Target Readership

The MOM target readership is Maker Governance, i.e., the set of MKR token holders.

## General Recommendations

- Use simple language.
- Use short sentences.
- Avoid unnecessary words.
- Remain open and objective.
- Provide examples when possible.
- Provide examples to help explain concepts, but avoid overcomplicating them.
- Use math when necessary, but keep it simple.

## Markdown

- Use [Github-flavored Markdown (GFM)](https://github.github.com/gfm/).
- Do not use blockquotes for anything other than the preamble.
- Use - (versus \*) for lists.
- Do not use more than one H1 heading.

## Links and URLs

### What to Link

- If a term has a corresponding MOM section, make it a link.
- Generally, if a term is critical for the proper understanding of a given section, make it a link.
- Avoid third-party external resources. MakerDAO-owned resources are to be preferred.

### Format

- For crosslinks within the MOM, use [relative URLs](https://www.w3.org/TR/WD-html40-970917/htmlweb.html#h-5.1.2).
- When crosslinking to parameters, use this format: `[Parameter name](relative URL)` parameter --- i.e., leave "parameter" out of the link.
- Use best judgment when a linked term occurs multiple times in a document: If instances are very close to each other and/or just too many, making them all links might increase visual noise with no added benefit.

## Spacing

Leave an empty line between headings and content:

> \# Heading
>
> There is an empty line right above this one.

## Parameter and Smart Contract Technical Names

When using the technical name for a parameter or a smart contract, use backticks around it --- e.g., \`cusp\` for the technical name of the [Max Auction Drawdown](https://manual.makerdao.com/parameter-index/collateral-auction/param-max-auction-drawdown) parameter.

Parameter technical names often (if not exclusively) appear after their non-technical name. Try to stick to a simple parenthetical mention, i.e., prefer "Max Auction Drawdown (`cusp`)" over "Max Auction Drawdown, also known as...", etc.

## Examples

When using equations as a setup for examples, use triple backticks. The underlying Markdown for [this example](https://manual.makerdao.com/parameter-index/debt-auction/param-debt-auction-delay) looks like this:

> \`\`\`
> Debt Auction Delay = 2 hours
> \`\`\`

Multiple example lines can be tucked between the triple backticks.

## Review Dates

- Dates must follow the YYYY-MM-DD format.
- Two trailing spaces must be added to the dates so that they will display correctly: YYYY-MM-DD**, where * = space.

## Capitalization and Naming Conventions

| Term | Proper form |
|--|--|
| Auctions | Lowercase |
| /budget(s)/ | Lowercase |
| /core unit(s)/ | Capitalized when attached to a core unit name, lowercase otherwise. Do not shorten to "CU" |
| /dai/ | Capitalized, unless it's "obviously" the ticker, as in ratios (MKR/DAI) |
| /facilitator(s)/ | Capitalized | Personal title |
| /governance/ | Capitalized when used as a collective noun (the set of MKR holders); lowercase otherwise |
| Governance Cycles | Lowercase unless attached to a month: _monthly governance cycle_, but _January Governance Cycle_ |
| /keeper(s)/ | Lowercase |
| /mkr/ | All-caps |
| /mkr holder(s)/ | MKR holder(s) |
| /vault(s)/ | Lowercase |
| Parameters | Capitalized |
| /on-chain/<br/>/off-chain/ | Lowercase |