Skip to content

Documentation

A current and accurate summary of the environment, with a date against it

The summary of an environment is the document everything else hangs off, and it is the one that goes stale fastest, because nothing breaks when it does. A switch gets replaced, the summary does not change, and a year later it describes a network that no longer exists.

Documentation of specific things sits with the thing itself: share structure and permissions in the Active Directory library, application licensing and support agreements under network environment, device configurations under network security. This library covers the summary that ties them together.

What this library checks

  • Whether the environment summary in your documentation platform is current
  • Whether it is accurate, which is the separate and considerably harder question
  • A set review frequency, so that current carries a date and not a feeling

Evidence you will be asked for

Every check in Spectra Core carries its own evidence. These are the artefacts an auditor, insurer or board most often wants to see for this area.

  • The summary itself, carrying a visible last-reviewed date
  • The name of the person who reviewed it against that date

Where this usually goes wrong

The test that matters is not whether documentation exists. It is whether the second engineer, at two in the morning, can act on it without phoning the first one. Most documentation passes the first test and fails the second.

Run this library against your environment

Every check comes with a risk level, a review frequency, an assignee and a plain-language rationale, so the output reads for leadership as well as for engineers. See the full workflow, or read how internal IT teams and managed service providers use it.

Related libraries

Last updated