I think a great traits one can possess is the ability to acknowledge and see his or her weak areas. I have come to realize that my documentation –> “sucks”! And I also think my predecessors didn’t do a very good job about proper documentation and setting down a set of standards and procedures.
I find as I am tackling more complex jobs – my support documentation is getting more complex as well. The simple text files and HTML files don’t cut it anymore. Keeping track and updating revisions is a nightmare – that one tries to do everything else but the required documentation.
I am looking at possibly DocBook and/or CVS. I have never used them. so before i invest time learning one or both of them – i thought i might throw the question out to the learned audience here and see what other people in similar situations do.
what do you use for creating documentation?
what do you use to keep track and manage versions and changes?
what do you use to distribute documentation to other IT staff and have them make changes & updates?
lastly, any good tips or advice you have gained from the field that you use and think they save you time and aggravation?
you might also want to include a little blurb of what kind of documentation you write. a software developer will have a very different method of documentation that a system admin or support analyst.
regards,
SL
