Micro-editing

The annotation pattern for verbatim substitution: the author has the correct replacement text and proposes it inline alongside the current state. Maps to the `edit` mode of the changeProposal shortcode.
Document Metadata
Title
Micro-editing
Access Level
0
Vector Action
inactive
Tags
terms

(log in required)
Loading...
Loading vector metadata...

Micro-editing is one of three architectural annotation patterns surfaced by the change-management skill. It applies when the author has the correct text and is proposing verbatim substitution.

The pattern is implemented as the edit mode of the changeProposal shortcode (rendered via src/_includes/parts/change-proposal/edit.njk). The card stacks the current state on top, the proposed state below with a directional arrow, and the rationale at the bottom β€” a structured comparison that makes the change scannable.

Use micro-editing for:

  • Typo corrections where the new spelling is obvious
  • Wording refinements where the author already knows the better phrasing
  • Small structural reorganizations within a paragraph
  • Insertions (omit the asis (current state) field) or removals (omit the tobe (proposed state) field) that should be visible to readers rather than silent

Companion patterns: Micro-RAGing (when the direction is known but the replacement text isn't), Micro-flagging (when expertise is needed and there's no proposed resolution).

Messages
Send a message to start a conversation with our support team.