documentation-governance

Community

Keep docs in sync with code.

Authorfm-dev-mx
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill prevents "Documentation Drift" by enforcing standards and workflows for creating, maintaining, and structuring documentation, ensuring it always aligns with the current codebase.

Core Features & Use Cases

  • Standardized Documentation Structure: Defines clear locations and content types for architecture, audit, and status documents.
  • Workflow Metadata Standards: Mandates YAML frontmatter for all workflow files, ensuring consistency in description, lifecycle, domain, owner, and review dates.
  • Anti-Drift Rules: Establishes a "Sync" contract requiring documentation updates in the same PR/Task as code changes.
  • Diagram Standards: Enforces the use of Mermaid for all diagrams (flowcharts, sequence diagrams).
  • Artifact Governance: Provides guidelines for task.md, implementation_plan.md, and walkthrough.md.
  • Verification Checklist: Ensures all documentation tasks meet defined quality and completeness criteria before being considered "Done".

Quick Start

Ensure all new documentation is linked in docs/DOC_STATUS.md and has a clear "Last Updated" date.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: documentation-governance
Download link: https://github.com/fm-dev-mx/celebra-me/archive/main.zip#documentation-governance

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.