On Tue, Jun 15, 2010 at 09:39:35PM -0400, Damion Alexander spake thusly:

> The problem I face is determining what information is important
> enough to document outside of RTFM.

I always start with a list or outline of things I need to
document. Then I prioritize it. What things would they be absolutely
screwed without? You can't write it all like one big book going from
start to finish. You never have enough time to do as complete a job as
anyone would like and you will never get to the end and important
stuff will get left out. So make sure you hit all of the really
important stuff first then go back and fill in the less important
details if you have time.

After a year of reconfiguring and rebuilding in my current place I
have quite a bit of documentation to do as well. Unfortunately, the
implementation of Mediawiki in place really stinks.

> The really oddball things I've encountered over time has already
> been documented. Such as "ignore this error message". However
> everything else is already documented by the vendor, either in
> manuals or the support sites.

I always link to the manuals and support sites for the general
stuff. Then make some notes about any special/unusual configs that
have been done.

-- 
Tracy Reed
http://tracyreed.org

Attachment: pgpkqIVtItKfN.pgp
Description: PGP signature

_______________________________________________
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/

Reply via email to