ACE3/documentation/development/documentation-guidelines-and-tips.md

---
layout: wiki
title: Documentation guidelines and tips
group: development
parent: wiki
order: 19
---

# Documentation guidelines





## Example entry
```
---
layout: wiki
title: Mission Modules
group: feature
parent: wiki
---

## 1. Overview

### 1.1 Sub-feature 1
Short description of sub-feature 1.

### 1.2 Sub-feature 2
Short description of sub-feature 2.

## 2. Usage

### 2.1 thing n°1
- Step 1.
- Step 2.
- Step 3.

### 2.2 thing n°2
- Step 1.
- Step 2.
- Step 3.

## 3. Dependencies

`ace_something`

## 4. Guides
```

# Guidelines

- A line between each entry like above.
- Use `ACE3` instead of `ACE 3`.
- Remove each entry that is not used.
- Don't forget to say what you're going to work on in #documentation in slack or [this topic] (https://github.com/acemod/ACE3/issues/1166)
- Keybinds in ``` <kbd>thoses thingies</kbd>  ```
- Keywords in ``` `thoses thingies`  ```
- Capitals at the start of a sentence and `.`at the end.
- VERIFY EVERYTHING IN GAME, ALL THE THINGS

# Tips

- Use http://dillinger.io/ to keep your sanity
- [Markdown cheat sheet] (https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)