On Mon, Mar 1, 2010 at 7:56 PM, <josh+s...@eldertimes.us<josh%2bs...@eldertimes.us> > wrote:
> So, I suspect like at least a few of you, I suck at documenting what > I've done. Unless I make a conscious effort to do it as I go along, > it often doesn't get, as the next fire takes priority. > > One thing we've implemented recently at work is a documentation queue in > our ticketing system. The idea being that if someone is looking for > information and can't find it on our internal documentation site, they > can drop in a ticket and the person responsible for that > system/service/whatever should get the appropriate docs written. This > (maybe) solves the problem of forgotten/overlooked documentation. > > But what about keeping up with documentation as tasks are accomplished, > new systems are stood up, etc? What tips do folks have for getting > better at documenting in their daily tasks? > > There are definitely procedural things we could do to improve this, and > we should probably be doing those, e.g., no system goes into production > without full and proper documentation. But we're not there yet, and > sometimes the nature of $WORK necessitates deploying things before we're > fully ready. That's a political issue, and has to be overcome in other > ways. > > So I guess what maybe I'm looking for is tips to help me improve outside > of the procedural/operational framework. Things like "spend the first > 15 minutes of every day documenting what you did the previous day" or > "make the n00b on the team do all the documentation." > > OK, so maybe that 2nd one is just wishful thinking :) > > -josh > One thing I haven't seen so far is a definition of who your audience is. Is it other admins, help desk, end users, managers, etc...? The approach you need to take is very different depending on the answer to that question.
_______________________________________________ Discuss mailing list Discuss@lopsa.org http://lopsa.org/cgi-bin/mailman/listinfo/discuss This list provided by the League of Professional System Administrators http://lopsa.org/
