Documentation

Documentation

• Product Opener documentation (web)
• Old API documentation

Documentation of OFF codebases and APIs

Product	Doc	Comment
Server code	Code doc	Example
API	API doc	Example
Android	Code doc	Example
Flutter	Code doc	Example
Dart package	Code Doc	Example
iPhone	Example	Example

2021 Documentation roadmap

Project tracking on GitHub

• Set up a bi-monthly call for documentation

Set up a process to make publication a breeze

• Publish the new documentation to our new servers
• Automate the publication of the documentation
• Deprecate the old wiki doc

Set up a process to keep documentation fresh

• Keep the documentation on par with the API
• Generate new separate, fast-moving documentation from the questions in #api or #general, and consider integrating some of it in the main documentation

Improve the documentation

• Document assumptions and things we (d/w)on't do