Index

README for the \<INSERT INSTRUMENT NAME HERE>

---

OVERVIEW

describe at a high level what this instrument does

---

VARIATIONS

describe what variations of this instrument exist. Eg. similar or identical mechanical design with different display units, dials, scale, etc.

---

APPLICABILITY

where is this instrument used

---

DEPENDENCIES AND INTEGRATIONS

describe what other instruments this relies on, and what other instruments pull data from it

---

OPERATION AND FUNCTION

describe specifics of how this instrument works

---

QUIRKS

describe unusual behaviors, corner cases, or things which otherwise cause us hours of troubleshooting before we realize that it just works that way