← Back to writing samples
Documentation Governance
Portfolio sample. Demonstrates documentation governance and authoring standards for enterprise knowledge base management.

Configuration Documentation Style Guide

Authoring standard for all configuration articles in the Meridian knowledge base. Every team producing config documentation follows these rules. Consistency across 400+ articles is what makes the KB usable at scale.

Voice and Tone

Second person. Present tense. Active voice. You are telling the reader what to do and what the system does in response.

RuleCorrectWrong
Use "Go to" for navigationGo to Admin > System Variables.Navigate to the System Variables page.
Use "displays" for system responsesThe Variable Detail panel displays.The Variable Detail panel opens / appears.
Use "select" for discrete choicesSelect Enabled from the Status dropdown.Choose Enabled from the Status dropdown.
Use "enter" for free textEnter the endpoint URL in the Base URL field.Type in the URL where indicated.

The Step/Result Pattern

Every procedure uses this pattern. Numbered step describes a single user action. Indented result immediately follows, describing the system response.

  1. Go to Admin > Care Programs > Program Settings.
    The Program Settings list displays all active programs.
  2. Select the program to configure.
    The Program Detail panel displays.
  3. Set the Auto-Enrollment toggle to On.
    The Enrollment Criteria section displays below the toggle.