10 Replies - 1456 Views - Last Post: 05 September 2011 - 02:50 PM
Posted 25 August 2011 - 08:03 AM
Everyone has different feelings on documenting things they work on or with. I personally am a big fan of documenting what i can. It helps me out when i have to revisit something and i have a document with some notes and screen shots that will help me out.
Example: you handled a incident were a server crashed. You documented your steps to resolve it and stash it away somewhere. 10 months later the server crashes again and its the same scenario. It's nice to have something to look back on in case you don't remember what you did 10 months ago.
So what do you document? How detailed are you? What do you feel it's importance is within IT? Does your employer require you to do it?
Replies To: Documentation
Posted 25 August 2011 - 09:00 AM
Posted 25 August 2011 - 10:56 AM
Imagine trying to program java without the java documentation, or on the Microsoft platforms with MSDN.
This post has been edited by AdamSpeight2008: 25 August 2011 - 11:58 AM
Posted 25 August 2011 - 11:34 AM
However if I am writing for a company or as a collaborative team i document to a higher level. People don't seem to get too upset.
In terms of documentation for networking/security is a must!, My Cisco CCNA course taught me one thing about advanced networks.. They crash and mess up a lot. When it comes to a companies network they want it back up and running ASAP. (Usually its some idiot who cant connect to the network and complains it's down. He switched his IP phone cable and PC Ethernet cables in the sockets on the wall for 'Their Convenience'... Sigh)
logs sound like an awesome idea!
Posted 25 August 2011 - 12:11 PM
That last one is actually kind of handy from time to time as it's not until you have to explain a new tool to someone else that you maybe see places where you could have made its implementation easier.
Posted 25 August 2011 - 08:23 PM
This. Plus it seems the original post was directed specifically at the other forms of documentation.
People love it when I provide screen-shots and detailed instructions for various tasks. And while I feel I can get by with most tasks with proper text-only instructions (or even vague guidance), seeing beautiful instructions with screen-shots can make the job so much better. I usually don't go as far as documenting what I did to fix some problem like jjsaw5, although when something identical happens months down the road I often wish I had. Problem is, I think I'd end up with so many documents that it'd be pretty difficult to navigate and find what I need, and most likely I'd never touch 99% of them, which would be a lot of time wasted for something I'd never use again.
I also tend to use a lot of custom in-house applications, many of which are prototypes and constantly changing. My awesome informational document or wonderful how-to might be useless, or downright wrong, in a matter of weeks due to changes.
Posted 26 August 2011 - 04:18 AM
On the other end, I like to make a screenshot of my GUI and provide the end user with some info about what that thing does. It's super obvious to me, but that might just be because I spent weeks / months developing it and watched the application grow bit by bit. If you get hit by the whole thing at once, odds are it's not as obvious anymore.
Posted 05 September 2011 - 02:50 PM
Also, I'm currently working on a website for a small firm, and I'm documenting everything in case someone else has to take over at some point.