Documenting infrastructure

From: Ivan Fetch (sunmanagers@cs.du.edu)
Date: Wed May 01 2002 - 01:10:49 EDT


Hello all,

   I'd like to start maintaining more documentation designed for
myself (reminders), folks who are replacing me (when that day comes), and
anyone needing to respond to an emergency if I'm unavailable. I invition
including such things as where non-packaged software is installed on our
servers, brief How-Tos on typical tasks (i.e. restoring backups, user
maintinance, jumpstarting new workstations), caveats on upgrading
frequently used software which gets patches often (including Solaris), the
organization of our IP address space, the configuration of our printers
(jet-direct -> Solaris -> Samba -> Windows clients), et cetera.

   I'm writing to solicit other people's opinions on the creation of
something like this - if you were starting a position, what kinds of
things would be helpful to have some background on vs. figuring things out
on one's own? How are you folks out there documenting your infrastructure
(as much for yourselves as for future employment)? Do most of you use
something like rcs or cvs to manage your configuration files (/etc,
/usr/local/etc)? What do folks use to type set electronic and printed
documentation -- I've been thinking latex or sgml -- I would like
automatic referencing (being able to refer to sections by number, title, and/or page number) as well as an automatically
generated table of contents.

   I appreciate any input you all are willing to give - I'll definitely
summarize. I'd like to start converting the various notes I've made while
reconfiguring things into a more organized and useful structure.

Thanks,
Ivan Fetch.
_______________________________________________
sunmanagers mailing list
sunmanagers@sunmanagers.org
http://www.sunmanagers.org/mailman/listinfo/sunmanagers



This archive was generated by hypermail 2.1.7 : Wed Apr 09 2008 - 23:24:16 EDT