Sierra Wireless should read this

embeddedgurus.com/embedded-bridg … mentation/

Although it focusses on providing hardware documentation to firmware developers, it applies equally to the documentation of anything with which a developer’s code has to interact.