Patterns in the Machine: A Software Engineering Guide to Embedded Development

© John T. Taylor, Wayne T. Taylor 2021

J. T. Taylor, W. T. TaylorPatterns in the Machinehttps://doi.org/10.1007/978-1-4842-6440-9_11

11. Documentation

John T. Taylor¹   and Wayne T. Taylor²

(1)

Covington, GA, USA

(2)

Golden, CO, USA

 

PIM views documentation as a tool, not just a chore to be done to appease the process gods. Furthermore, documentation is more than just a record of what was designed and implemented; it is a development tool that adds value to any project by

• Providing a canonical reference

• Providing a higher level of abstraction for identifying, analyzing, and specifying solutions

• Providing a concrete medium for reviews

• Being easier and faster to rework than source code

• Bridging the gap between individuals and disciplines

• Providing training and ...