This week's book giveaway is in the OO, Patterns, UML and Refactoring forum. We're giving away four copies of Refactoring for Software Design Smells: Managing Technical Debt and have Girish Suryanarayana, Ganesh Samarthyam & Tushar Sharma on-line! See this thread for details.
I'm trying to document the configuration information for our project's installations of Weblogic and I feel like this sort of thing must be done on most projects. Anyone have any pointers, or even better examples, of a good way or model to follow? I'm trying to think of the important information to capture if a new person was to come on and need to reconfigure or reinstall anything.
We use a Wiki (TWiki) as a clearinghouse for all our information. We've got diagrams of how the servers are configured in the firewall (what ports get redirected to which server), instructions on how to set up a developer workstation starting with bare WinXP, a list of common problems and their solutions, a dictionary of terms and abbreviations particular to our workplace and standard operating procedures for the person "on call", just to give you an idea of some of the things we document.
Then in the root directory of every project I create (I have a few dozen) there's a README file which details the project-specific details regarding how to build and deploy the project. The build usually starts with a batch file to set up the environment (rather than depending on the developer to set up the environment themselves) and Ant to do the work of building and deploying. That way when one checks the code out of source control (you do use source control, right?) he doesn't have to rely on trial and error to get the thing to run.