> From: discuss-boun...@lopsa.org [mailto:discuss-boun...@lopsa.org] On > Behalf Of Damion Alexander > > If you were in this situation, on either side, what would you expect in > that in-house documentation?
I am obsessively compulsive about documenting. Here's what I do, and what I recommend: Don't write down how to figure out problems. Whoever is taking over after you must be competent, and have access to RTFM on their own. They'll have to figure things out on their own. Document procedures, passwords, settings and details which a competent person would need to ask you, if they were sitting down figuring out a problem next to you. Document procedures for things which need to be repeated - in order to make them consistently repeatable. And document the "big picture" such as the network diagram, or other architectural diagrams. PS. My teammates and I do share a directory of such documents, and each of us will occasionally document some errata sort of thing. "Note: To perform X, Y, or Z on cisco IOS, do the following commands..." The value of such a document is for your own knowledge; it makes you remember better because you wrote it down, but it's not very valuable to other people because it's not the sort of thing they can expect to be present, and findable. _______________________________________________ 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/
