skills.rest
fm-dev-mx
fm-dev-mxCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

documentation-governance

Enforce documentation structure and anti-drift rules with Mermaid diagrams.

Updated Jun 21, 2024
Search Tags:#workflow#documentation#mermaid#governance#standards#sync
One-click install
npx skills add https://github.com/fm-dev-mx/celebra-me --skill documentation-governance
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-governance
Source: https://github.com/fm-dev-mx/celebra-me/tree/main/.agent/skills/documentation-governance
Command: npx skills add https://github.com/fm-dev-mx/celebra-me --skill documentation-governance

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about documentation-governance

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

FAQPage Schema
How do I prevent documentation drift between code and project docs?▼

Documentation drift is prevented by enforcing a strict sync contract requiring documentation updates within the same PR as code changes. This ensures docs remain accurately aligned with the current codebase structure.

What is the standard structure for project documentation governance?▼

Project documentation governance standardizes locations and content types for architecture, audit, and status documents. It mandates YAML frontmatter for workflow files to track lifecycle, domain, owner, and review dates consistently.

How do I enforce Mermaid diagram standards in my project documentation?▼

Mermaid diagram standards are enforced by mandating the use of Mermaid syntax for all flowcharts and sequence diagrams. This ensures diagrams are versioned, text-based, and easily verifiable alongside code changes.

How do I verify documentation completeness before merging code changes?▼

Documentation completeness is verified using a predefined checklist ensuring all quality criteria are met. The system checks that new documents are linked in DOC_STATUS.md with a clear Last Updated date before approval.

What are the guidelines for governing task and implementation plan artifacts?▼

Artifact governance provides specific structural guidelines for task.md, implementation_plan.md, and walkthrough.md files. This ensures project artifacts maintain consistent formatting and lifecycle metadata across development workflows.

Do I need YAML frontmatter for all workflow documentation files?▼

YAML frontmatter is mandated for all workflow documentation files to ensure consistency. It tracks essential metadata including description, lifecycle status, domain, owner, and review dates for proper document governance.

Related Skills

Explore More Software Engineering Skills→
samjhechtsamjhecht
4

initialize-governance

Generate Constitution, Roadmap, and process documentation templates for project governance.

Community
Advanced
I-OnlabsI-Onlabs
3

pipeline-test-verify

Automate pre-commit verification for unit, integration, security, and documentation checks.

Community
Advanced
luanzebaluanzeba

mermaid

Validate Mermaid diagrams syntax in .mmd files and Markdown blocks, rendering SVG output with ASCII previews.

Community
Intermediate
channgchanng
20

docsify

Generate static documentation websites from markdown files with sidebar navigation.

Community
Basic