document

Generates release documentation records and documents from a current audit's measurements.

1|Updated Jul 21, 2026
One-click install
npx skills add https://github.com/fallguyconsulting/ok-plugins --skill document-fallguyconsulting
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document
Source: https://github.com/fallguyconsulting/ok-plugins/tree/main/plugins/ok/ceremonies/document
Command: npx skills add https://github.com/fallguyconsulting/ok-plugins --skill document-fallguyconsulting

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping release documentation accurate and current is tedious: catalogs drift from the shipped surface, assessments lose their evidence, and documents go stale between releases. This Skill runs a release-documentation ceremony that constructs the entire documentation corpus from a current audit's records, so every claim traces back to a measurement taken at the release commit. ## Core Features & Use Cases - Audit-driven construction: Ensures a current audit exists (running /audit when the tree has moved past its stamp), then builds the catalog, assessments, and trap registry from the audit's extraction and determinations without measuring anything itself. - Vantage-split corpus: Produces a publishable layer in shipped vocabulary (catalog, assessments, traps) and an internal verification layer, keeping source paths and internal entry points out of publishable records. - Declared document types: Brings each document type declared under .ok-planner/surface/documents/ up to date at its target path, revising existing documents rather than rewriting them, and stamps everything with the release commit. - Use Case: After tagging a release, run /document v2.1.0 to regenerate the public catalog, story and assumption assessments, and trap registry from the audit, revise the README-style documents at their declared targets, and commit the stamped corpus in one commit. ## Quick Start Run /document with a release tag or commit to regenerate the project's documentation corpus from a current audit and commit the stamped records and documents.

Frequently Asked Questions about document

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate release documentation from an audit?▼

Invoke /document with a release tag or commit. The ceremony ensures a current audit exists, then constructs the catalog, assessments, and trap registry from the audit's records and revises each declared document type at its target path.

Does the document ceremony run its own measurements or experiments?▼

No. The ceremony measures nothing itself; it constructs records from the audit's surface extraction, story determinations, and assumption dispositions. If the audit is stale, it invokes /audit first rather than recomputing anything.

What happens if the .ok-planner estate is missing?▼

The run stops and reports the missing estate. The .ok-planner directory is required because it owns the story catalog, document types, documentation corpus home, and the audit this ceremony constructs from.

Will it overwrite documents I edited by hand?▼

No. The writer revises the document already at the type's target, keeping every sentence the tree still supports, including owner edits. It composes a new document only where the target is empty.

When is the audit reused instead of rerun?▼

The audit is reused when the diff from its stamped commit to the release tree touches only the audit's own output paths. Otherwise the ceremony invokes /audit, which runs the documentation walk immediately after its extractor returns.