2

I regularly write and update technical documentation which will be used to set up a new virtual machine, or to have a lookup for system dependencies in networks with around 20-50 (server-side) computers. At the moment I use OpenOffice Writer with text tables, and create one document per intranet domain.

To improve this documentation, I would like to collect some examples to identify areas where my documents can be improved, regarding general structure and content, to make it easy to read and use not only for me but also for technical staff, helpdesk etc.

Are there simple text templates (for example for OpenOffice Writer) or tools (maybe database-driven) for structured documentation of a computer configuration?

Such a template / tool should provide required and optional configuration sections, like 'operating system', 'installed services', 'mapped network drives', 'scheduled tasks', 'remote servers', 'logon user account', 'firewall settings', 'hard disk size' ... It is not so much low-level hardware docs but more infrastructure / integration information in these documents (no BIOS settings, MAC addresses).

mjn
  • 933
  • 2
  • 12
  • 26

1 Answers1

0

Maybe you could use something like the SYDI Project, Open-AudIT or OCSInventory could be used to generate basic network layout that could be exported to OOo Write or Calc and then extended with what you need?

I have no personal experience with any of theese projects, however SYDI Project says on its website that it has conversion from its XML format to OOo Calc which may be something you are looking for.

Community
  • 1
syserr0r
  • 500
  • 3
  • 10