1 / 8

User Documentation

ICANWK525B Configure an Enterprise Virtual Computing Environment ICTSUS5187A Implement Server Virtualisation for a Sustainable ICT system. User Documentation. Documentation. You cannot build a system for a client and leave them without adequate documentation

xyla-dotson
Download Presentation

User Documentation

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. ICANWK525B Configure an Enterprise Virtual Computing EnvironmentICTSUS5187A Implement Server Virtualisation for a Sustainable ICT system User Documentation

  2. Documentation • You cannot build a system for a client and leave them without adequate documentation • Computer systems are complex, require configuration and often training to use • Without documentation, a system is useless

  3. Documentation Types • Hardware and Software Manuals • As provided by the manufacturers • Support and Warranty documentation • How to get help with things break or need to be replaced • Physical Documentation • Type of hardware, location of equipment in which room, which rack, cabling used • Logical Documentation • Network interconnectivity

  4. Documentation Types • Overall system design • Features, flaws, why you designed it like this • How does it meet business objectives • Scope of solution: what was your job, what wasn’t • Virtualisation Software Configuration • What type (vSphere, Hyper-V) • Base OS or software, e.g. Windows Server 2008 • Configuration details, e.g. clusters of hosts • Virtual Networking Details • Virtual switches: types, names, purpose • IP addresses and masks

  5. Documentation Types • Disks, NAS, Disk partitioning • Existing VMs • If you migrated from real hardware, detail any differences in their configuration: RAM, disk, CPU, network capacity etc. • User documentation • Admins and users need to know how to use the solution: create new VMs, manage VMs, discard VMs, reconfigure VMs • Tutorial style • Security, authentication, authorisation docs • Who can do what, who can’t etc.

  6. Documentation Style • Formal documents • Not informal or colloquial • Must be specific and not vague • Exact details • Change over time • Ensure you use version numbers and dates • If possible, authors names and contact details • Customer should get paper and electronic copies of all documentation • They must be up to date!

  7. Documentation Examples • Best way to understand documentation is to read some examples • We will look at the design and user documentation for the vSphere solution installed at GCIT Coomera

More Related