Documentation Guidelines

Writing Markdown:

• Use single empty lines as separators. Not two, not zero.
• Write each sentence on a dedicated line. This helps make git diffs more readable. Long sentences should be broken into separate lines at a sensible point, so that lines are not longer than 120 characters.

What (not) to document

FMD Android is designed to be stand-alone. You should be able to use and understand FMD without having to leave the app. For example, the app explains how the different commands and transport channels work.

The online documentation is only a fall-back. It provides more information when the user is facing a problem or wants more detail.

For that reason, the online documentation should not repeat information that is already given in the app. It will just get out of sync over time.