# Create examples of ranking complexity when documenting your project

Date: 2021-02-28 14:52:58 +08:00Date modified: 2021-07-22 13:59:53 +08:00

Some projects such as user applications include examples of usage varying of the complexity from a simple "Hello world"-esque example to a real-life example that the developer uses. This acts as a quick introduction to the project as well as subtly giving hints about what you can do with the program. Examples include...

- The manual pages from the FreeBSD project where each tool is given a dedicated section for example usage.

- maim, a screenshot capture tool, has one of the examples demonstrate that you can pipe binary output which leads to useful things such as OCR selection or a colorpicker.

This makes it easier to skim (see Speedreading is all about skimming well) and to Prefer referencing over remembering. Furthermore, Examples and stories are more memorable than explanations.

## Backlinks

- Write down the simplest possible example
- Classic prose
- Make a style guide for consistency
- Writing