Skip to navigation
ReferenceQualitySkill Behavior ContractsPlanning and Authoring

Write Documentation Skill in DocsFab

Dev
View as Markdown

write-documentation is the focused DocsFab authoring skill shared by the runtime workflows. The runtime selects create, update, revision, or restructure mode and supplies the approved plan, repository, revision, and write authorization. For more information, refer to Planning and Authoring Skills in DocsFab.

Focused Edits

For a request such as “tighten this paragraph” or “make these instructions easier to follow,” the live agent can use write-documentation directly. The requested target and correction supply the brief. The skill preserves technical meaning, follows repository conventions, and checks the affected passages. It requires write authorization but no separate planning step, typed plan binding, SRD, or HTML artifacts. It reports changes and validation limits; independent review remains a separate responsibility.

The standalone polish-documentation skill has been removed. Use write-documentation for both focused polish and broader authoring.

Runtime Bindings

WorkflowSkill modeMutation scope
create-documentationCreateThe requested new page or documentation set.
update-documentationUpdateThe smallest approved change-scoped documentation set.
restructure-documentationRestructureThe mapped documentation set, including supported routes, anchors, references, and navigation.

The skill also defines revision mode for an approved bounded revision. The current catalog manifests expose create, update, and restructure as the operator workflows.

Output Contract

The skill records sources, changed paths, assumptions, unresolved questions, compatibility actions, and claims that need verification. It stops after the bounded mutation. It does not plan, review, score, expand the approved scope, publish, or perform SCM changes.

Source-Fact Method

write-documentation does not own source-fact discovery. It cites the method owned by verify-technical-accuracy, treats a host-sealed ledger as untrusted evidence, re-reads cited spans, and does not add a writer-owned inventory artifact.

Authoritative Sources