Documentation - Githubissues

Andover-Robotics / ARC-Core

This is the combined common code base for Andover Robotics Club, packaged in a library.

0 stars 9 forks source link

Documentation #3

Open broad-well opened 6 years ago

broad-well commented 6 years ago

This issue is meant for the discussion of standard practices in documenting this project.

Possible methodologies and subtopics include:

JavaDoc
Pseudocode
Wiki content
In-line comments

LakeYin commented 6 years ago

Documentation should first be placed in the Drive with the standard template since it would be most convenient for when the Engineering Notebooks are assembled (and that is the most important use for documentation).