-
Notifications
You must be signed in to change notification settings - Fork 62
Style Guide
Hamish Willee edited this page Jan 25, 2016
·
3 revisions
UNDER CONSTRUCTION This has not yet been agreed/approved.
This is the style guide for the Solo Dev Guide. The instructions are intended as general guidance for contributors.
-
Target audience is primarily external developers wanting to create dronekit apps, smartshots and/or hardware accessories for Solo. Internal developers are a secondary audience who should be supported if possible without compromising quality for external developers.
-
Use US English
-
Use SI (metric) units for text and images.
- Additional unit types may be specified (e.g. imperial measurements) but these should be "as well".
- Non standard units may be used if they are an industry standard. For example "C" units (Amps * battery capacity) are commonly used to describe battery charge rates.
-
Be consistent. Documents covering similar ideas (e.g. Hardware pages) should attempt to have similar structure/headings