Documentation – Why All The Cool Kids Are Doing It

Rich TroutonPart of XW16

Documentation is many things: surrogate memory, teaching tool, an emergency tool, and vacation-saver. One thing it is not is spontaneously generated; somebody needs to write it! This session will cover why you should have documentation, when it needs to be created, and how to compose documentation to best address different potential audiences.

The session will also discuss tips and tools, with the goal of helping you quickly create documentation that answers others’ questions without their needing to interrupt your train of thought or your vacation.



Rich Trouton has been doing Macintosh system and server administration for over eighteen years and has supported Macs in a number of different environments, including university, government, medical research and advertising. His current position is providing support for Howard Hughes Medical Institute’s Janelia Research Campus in Ashburn, Virginia.