On Mon, Mar 1, 2010 at 4:56 PM,  <[email protected]> wrote:
>  What tips do folks have for getting better at documenting in their daily 
> tasks?

Hey, Josh,

  Do you have an infrastructure for documentation that makes it easy
and pleasurable to add or update documents?  If not, you need to
develop one.  Personally, I like the power of DocBook XML, and the
convenience of an AsciiDoc front end to cut down on the tag soup.

  Once the infrastructure is in place, it becomes a matter of practice -- when
you make a manual system change, update your Build Book (or, if possible,
do it using your automated configuration management system in the first
place -- then, like Atom Powers does, you can get documentation from your
configuration management system rules .)

  Good on you for deciding to improve your documentation!

Best,
-at

_______________________________________________
Discuss mailing list
[email protected]
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