Inspired by Loner's comment in Aga's thread.
I'm a pretty meticulous documenter at work. I make notes any time I create new assumptions or change assumptions, complete with explanations of my thought process behind doing so. I write comments in all my code explaining what each routine does, what variables it uses, and what values it returns. I have even written short little user guides for propriety programs I've developed.
So far this has worked to my own benefit. Whenever people ask questions about my work I can easily point to answers and whenever I'm asked about results I produced a long time ago, I can easily reproduce them.
I recognize though, that this is also very good for my company's "organizational memory" (formletter! terrible corporate buzzword alert!). My work is very easy to follow should someone decide to hit me with the proverbial bus.
I'm not too worried about this right now because I'm constantly being given new assignments (as opposed to being asked to click the same buttons every month to produce the same reports), but even still,
Could this come back to bite me?
Should I be holding things back?
Do you do this?
I'm a pretty meticulous documenter at work. I make notes any time I create new assumptions or change assumptions, complete with explanations of my thought process behind doing so. I write comments in all my code explaining what each routine does, what variables it uses, and what values it returns. I have even written short little user guides for propriety programs I've developed.
So far this has worked to my own benefit. Whenever people ask questions about my work I can easily point to answers and whenever I'm asked about results I produced a long time ago, I can easily reproduce them.
I recognize though, that this is also very good for my company's "organizational memory" (formletter! terrible corporate buzzword alert!). My work is very easy to follow should someone decide to hit me with the proverbial bus.
I'm not too worried about this right now because I'm constantly being given new assignments (as opposed to being asked to click the same buttons every month to produce the same reports), but even still,
Could this come back to bite me?
Should I be holding things back?
Do you do this?
To document or not to document?
0 commentaires:
Enregistrer un commentaire