Labsco
microsoft logo

documentation

✓ Official1,245

by microsoft · part of microsoft/hve-core

Canonical documentation capability for audit, drift, validate, and author modes in hve-core.

🧩 One of 7 skills in the microsoft/hve-core package — works on its own, and pairs well with its siblings.

This is the playbook your agent receives when the skill activates — you don't need to read it to use the skill, but it's here to audit before installing.

documentation

Overview

This skill provides the shared documentation capability used by the Documentation agent. It centralizes the durable knowledge for audit, drift, validate, and author flows in a single package so thin wrappers can load mode-specific guidance instead of embedding capability prose inline.

Mode map

The Documentation agent should load the relevant skill sections by mode:

ModePrimary load targetsNotes
auditreferences/conventions.md, references/coverage-method.md, references/validation-toolchain.md, references/content-sensitivity.mdReplaces the former Doc Ops workflow with a skill-driven audit loop.
driftreferences/conventions.md, references/code-doc-mapping.md, references/content-sensitivity.mdUses the repo-local mapping table and drift heuristics.
validatereferences/validation-toolchain.md, references/accessibility-checks.md, references/content-sensitivity.md, references/rai-guardrails.mdRuns docs validation and escalates formal review when needed.
authortemplates/guide.md, templates/reference.md, references/conventions.md, references/accessibility-checks.md, references/content-sensitivity.md, references/rai-guardrails.mdProduces narrative or reference docs with the repository's documented conventions.

Non-goals

This skill does not author ADRs, BRDs, PRDs, or other planning artifacts. It also does not embed accessibility, RAI, or security standards logic inline; it points to the dedicated reference files and routes formal assessment to the appropriate planner when the scenario requires it.

Working conventions

  • Prefer existing repository instructions and scripts over duplicated prose.
  • Keep documentation changes factual and scoped to the current task.
  • Use the reference files below for mode-specific methods, heuristics, and checklists.
  • Escalate to planners for formal accessibility, RAI, or security review if the work requires a specialist assessment.

Session tracking

Write session state to .copilot-tracking/documentation/ using a {{YYYY-MM-DD}}-session.md file for the run, following the standard session file conventions.

Reference files

  • references/conventions.md — Synthesis of the repository's markdown, writing-style, and Docusaurus conventions.
  • references/code-doc-mapping.md — Code-to-documentation mapping table and drift heuristics.
  • references/coverage-method.md — Gap and coverage analysis method for audit mode.
  • references/validation-toolchain.md — Validation command catalog and result interpretation.
  • references/accessibility-checks.md — Inline documentation checks and handoff triggers.
  • references/content-sensitivity.md — Pre-publish PII, secrets, confidentiality, and AI-disclosure checks.
  • references/rai-guardrails.md — Injection-boundary, attribution, human-review, and disclaimer guidance.

Templates

  • templates/guide.md — Structure template for narrative guides and how-to pages.
  • templates/reference.md — Structure template for reference and API-style documentation.