All code, no documentation

By Gord at May 30, 2010 16:46
Filed Under: Blog

As part of my work, I must document everything.  Being a code monkey it is sometimes hard to change gears between coding and documenting.  When I do get around to documentation there are odd things that happen that make me realize I have been coding too much.  As a result, I've compiled the list below.

This is a list of things that happen to code monkeys when they try and write documentation:

- your sentences end with semi-colons

- you try and delete lines of text with shift-delete

- rather than ctrl+s to save your document you hit ctlr+shit+b to build

- you try and comment-out various parts of your documentation

- when someone asks you for a technical spec you send them the code

- your document headings start with "public void"

About the author

Gord graduated from Carleton University with a bachelors of Computer Science with minors in both Philosophy and Mathematics.  His post graduate career started in 2005 as a Systems Administrator until becoming a .Net Web Developer 2 years later.  Since then, he has moved on to being a more generic Systems Developer, focusing on intersystem communication, design, and architecture.

Page List