Creating Developer Documentation

Note

This document is not complete. Feel free to add, edit, and suggest changes.

Developer documentation serves to function as a means of knowledge sharing. As we iterate on this process, we will learn better ways to ensure we accurately capture the necessary information.

As a starting point, here are some things to keep in mind:

• Document the implementation in the context of its functionality
• Document how the execution is triggered
• Capture the flow of execution, not the layout of the file(s)
• Include any design decisions that inspired discussion / is not intuitive