On Fri, Jun 18, 2010 at 6:13 AM, Joe McDonagh <joseph.e.mcdon...@gmail.com> wrote: > Damion, are you using puppet? If so, I recommend you do your docs inside > the manifests and use puppetdoc to generate an up-to-date set of docs > every night. Writing docs by hand at a volume of ~100 servers is not > something most people will want to keep up to date.
I do something similar with our Cfengine install - each rule has a comment starting with "cfengine-policy-description:" which gives a nutshell description of the policy and why it is there. Then I can "grep cfengine-policy-description: cf.*" to grep out all the nutshell summaries and plop them into a doc of their own. I understand Cfengine 3 has hooks for knowledge management in the commercial version but I haven't played with that yet. Best, -at P.S. Damion, you might take a look at my Sys Admin Site Documentation template at http://www.verticalsysadmin.com/sa-site-doc/ -- you might find some inspiration there. The template's out of my post on implementing site documentation in docbook (http://lopsa.org/node/1829) though nowadays I'd use asciidoc so I don't have to eat XML tag soup. You might get some ideas there, and I recommend the sources for said post: "Documentation Writing for System Administrators" by Mark C. Langston, and TPOSNA. _______________________________________________ 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/
