doc-consistency

Prompt for approval before propagating doc updates after code or metadata edits.

Updated May 21, 2026
One-click install
npx skills add https://github.com/mica-agent/mica-solar-system --skill doc-consistency
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-consistency
Source: https://github.com/mica-agent/mica-solar-system/tree/main/.qwen/skills/doc-consistency
Command: npx skills add https://github.com/mica-agent/mica-solar-system --skill doc-consistency

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill prevents documentation drift by ensuring that when code or documented behavior changes, the corresponding docs stay accurate for what users actually experience.

Core Features & Use Cases

  • Ask-on-inkling synchronization: triggers doc-update decisions when edits could make sibling docs inaccurate, using an explicit user approval gate rather than silent propagation.
  • Bidirectional drift detection: covers both directions—editing docs that describe code and editing code (or metadata/HTML/CSS) that docs describe—then flags possible user-observable mismatches.
  • Scoped, cascade-proof updates: updates only the docs the user authorizes, with stop conditions to avoid broad fan-out without fresh confirmation.

Quick Start

Use doc-consistency when you modify a design/spec or when you change implementation files that a spec describes, then ask the Skill to identify which sibling docs might need propagation before updating anything.

Frequently Asked Questions about doc-consistency

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

FAQPage Schema
How do I prevent documentation drift when making code changes?

To prevent documentation drift, an explicit approval gate prompts you before propagating updates to sibling design or decisions docs. This ensures spec sync with user-observable behavior changes without silent cascades.

How does bidirectional drift detection work for spec sync?

Bidirectional drift detection flags user-observable mismatches in both directions: editing docs that describe code, and editing implementation files that docs describe. It identifies which sibling docs need propagation before updating anything.

Does doc-consistency work with metadata.json and HTML files?

Yes, doc-consistency applies to synchronized maintenance across sibling docs and implementation files including metadata.json, HTML, CSS, and JavaScript. It works in any workflow with spec-first review.

What's the best way to keep specs and code aligned every edit?

The best way to keep specs and code aligned is using an ask-on-inkling synchronization policy that prompts for doc-update decisions when edits risk making sibling docs inaccurate. Updates are scoped with stop conditions to prevent uncontrolled cascades.

Do I need YAML frontmatter to use doc-consistency?

Yes, YAML frontmatter-driven discovery behavior is required. It enables the inkling-threshold policy that asks the user before propagating updates to avoid silent drift and uncontrolled cascades.

When should I not use automated doc propagation for spec updates?

You should avoid silent automated doc propagation when edits could trigger broad fan-out. Doc-consistency uses scoped, cascade-proof updates with explicit stop conditions to prevent uncontrolled cascades without fresh user confirmation.