ChadDa3mon - Slashdot User

Comment Re:bad (Score 5, Informative) 401

by ChadDa3mon on Thursday February 19, 2009 @12:58PM (#26918273) Attached to: How Do You Document Technical Procedures?

I think you misunderstood what I'm saying. I'm not documenting this for 'my' job, nor am I worried about my job security. I am trying to write documentation for 150 people around the world to follow so that we're all doing things the same way.

Submission + - How do you document technical procedures? 1

Submitted by ChadDa3mon on Thursday February 19, 2009 @12:11PM

ChadDa3mon writes: I work for a large MSSP type operation and we deal with a plethora of vendors, versions, and....skill sets. We're facing a critical problem as we grow when trying to deal with these varying degrees of technical competency. The end result is we're getting to the point where we have to document every procedure and process, no matter how mundane or 'common sense' it may seem.

I've got a picture of how I'd like this to work in my head, but I can't find any software out there that seems to go along with it. I'm a big fan of keeping things simple, so I'd like to start with high level overviews. Each step in the process would be a general statement like "Look for valid traffic on the monitoring interface". For those who already know what 'valid traffic' means, it's easy to follow. However, if there was someone who was unsure what it meant, there would be a link they could click on that would pop open a new window (or something similar) explaining in detail what we're looking for and how to find it. It's my hope that using this process, people aren't just blindly running commands, but gaining an understanding into what that command is, and why we use it, what to be aware of etc....

This seems like a job for a flow chart, but I don't like the setup of any of the ones I've used, such as Visio. It could also maybe fulfilled by a wiki, but there's so many out there I don't know where to start. I have to assume I'm not the only person who's facing a problem like this, so I'm hoping someone else out there can make some recommendations.

Slashdot Top Deals