# Style Guide and Templates

## Style Guide

* Processes are divided into sections. Use separate files for each section.
* Need to explain clearly what the user is doing and the effect that will be produced after the operation.
* The background knowledge needs to be provided with necessary explanations, and if necessary, some external links are provided.
* Frequently provide commands to check whether the previous operation was successful.
* After each operation, if necessary, provide troubleshooting to prevent users from aborting due to anomalies.

## Templates

### Section property

> - **Objective:** which aspect to evaluate / what to learn from the section
> - **Prerequisites:** background knowledges / TiDB concepts (provide links) / prerequisite tasks / required hardware resources
> - **Optionality:** Required / Optional / recommended in some cases (be specific) / cannot perform in some cases (make it specific)
> - **Estimated time:** Time required to complete this task

### SubSection property

> - **Optionality:** Required / Optional / recommended in some cases (be specific) / cannot perform in some cases (make it specific)

### Operation and Verify

describe the operation

#### Commands
describe the command

$ command-1 arg-1 arg-2
$ command-2 arg-3 arg-4 arg-5

#### Verify
describe the verify method

$ check-command args-1
sample output1
sample output2

#### Troubleshooting

##### describe the unusual case

describe the reason and how to fix

##### describe another unusual case

describe the reason and how to fix