Documentation Standards & Guidelines - portapack-mayhem/mayhem-firmware GitHub Wiki
General Style Guidelines
- Language should be English
- Style should tend more toward "user manual" than "blog post".
- Images should (where possible) be located in the wiki git repository in 'img/'.
Page Structure
Applications Pages
Applications Pages should adhere to he following structure:
High Level Description
This is a brief description of the Application. Limit to 3 or 4 sentences. No need for elaboration of terms or definitions.
User Interface
What the various regions and controls on the UI do. This should contain a screenshot with the various regions highlighted.
Functionality
Detailed description of the usage of the application.
Examples
Specific use-cases. Possible inclusions - sample file outputs, screenshots etc.