Skip to main content

App Title

Two-three sentences slogan for the app.

Features​

Dotted list of the main app features.

Installation (app version)​

Concise install guide for production, including required app secrets. Conclude with how to open the app (e.g. if it has context menu interactions).

User Guide​

User-friendly description of how the app should be opened, on what entities/files it works and what are the main operations/flows that can be performed with it.

FAQ​

Question/Answer pairs to troubleshoot common issues or limitations of the application.

Developer Guide​

Description of the core structure of the app from a developer's point of view; what to do and what not to do when working with the app.

Known Limitations​

List of known bugs, edge cases or missing features under which the app will not work as expected.


For an example of documentation, see here: Example [README.md]([http://README.md)](example-readme.md)