ArchDocs
Start free

Documentation health

Documentation health lists stale documents and gaps that need a person's review. Open it to decide which diagrams to check or where documentation is missing.

Viewing health requires docs:read. Marking a document current or assigning a document's owner requires docs:write. Assigning an object's owner requires objects:manage, and assigning a space's owner requires spaces:manage.

Select Health under Tools in the sidebar for the organization view. A space's Health tab limits the view to that space.

Check stale documents

  1. Select Stale documents.
  2. Open a document and check whether it still describes the system. Edit anything that has changed.
  3. If the diagram is still accurate without an edit, return to the list and select Mark as current.

Staleness starts at the later of the document's last update or its last verification. The default threshold is 90 days. The list's order also accounts for references, dependent objects and public sharing, so the oldest diagram isn't always first.

Mark as current records your verification without changing the diagram. Health doesn't compare the diagram with the running system. A stale document can still be correct, and a recently edited one can still be wrong.

Assign an owner

Use the Owner dropdown beside a listed document, object or space to choose an organization member. The selection saves immediately.

A document's owner is resolved in this order:

  1. Its explicitly assigned owner.
  2. The explicit owner of the object it's attached to.
  3. Its space's owner.
  4. Its creator, if there's no assigned or inherited owner.

The source appears beside the name as Owner, From object, From space or Creator. A creator fallback still counts as an unowned document: creating a diagram doesn't make you responsible for maintaining it. Choosing No owner clears the explicit assignment and restores the fallback.

Review gaps

Select a category to see its records:

CategoryWhat it finds
Unowned documentsDocuments with neither an explicit nor an inherited owner.
Owner left the orgDocuments, objects or spaces whose resolved owner is no longer an organization member.
Undocumented objectsObjects with no attached documents and no incoming references.
Empty doc slotsDocument slots defined by an object's kind that have no document attached.
Broken referencesDocument references whose target is missing or deleted.

Open the listed record to address the gap. Objects and references explains the connection between an object, its documents and the references that use it.

Weekly digest

When enabled for the organization, the weekly health email goes to people with stale documents or Owner left the org findings assigned to them. Unowned-document findings go to the documents' creators. The email includes stale document counts and a short list to review. It respects the recipient's digest email preference.

The digest is off by default. The app currently has no setting to enable it or change the staleness threshold.