Consulting: Organizing site/environment documentation for customers?

Posted by ewwhite on Server Fault See other posts from Server Fault or by ewwhite
Published on 2013-11-10T18:38:07Z Indexed on 2013/11/10 22:01 UTC
Read the original article Hit count: 247

Filed under:
|
|

Over time, I've taken on consulting and contract engineering work for various clients. More recently, customers are asking for certain types of documentation.

These are small businesses and typically do not have dedicated technical staff. Within a single company, Wiki/Confluence/Sharepoint, etc. all make sense as a central repository for documentation and environment information.

I struggle with finding a consistent method to deliver the following information to discrete customers. I'm shooting for a process that's more portable, secure and elegant than a simple spreadsheet or the dreaded binder full of outdated information.

  • Important IP addresses, DHCP scope, etc.
  • Network diagram (if needed).
  • Administrative usernames and passwords and management URLs.
  • Software license keys.
  • Support contracts and warranty information.
  • Vendor support contacts and instructions.

I know there are other consultants here. Any suggestions or tips on maintaining documentation across multiple environments in a customer-friendly format? How do you do it?

© Server Fault or respective owner

Related posts about documentation

Related posts about wiki