documentation

Enforce YAML frontmatter headers and prioritize updating existing documentation.

9|2|Updated Jan 31, 2026

Search Tags:#workflow #changelog #templates #documentation #mermaid #metadata

Ready to run

npx skills add https://github.com/aussiegingersnap/cursor-skills --skill documentation-aussiegingersnap

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/aussiegingersnap/cursor-skills/tree/main/skills/documentation
Command: npx skills add https://github.com/aussiegingersnap/cursor-skills --skill documentation-aussiegingersnap

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintains organized, well-structured project documentation by enforcing YAML frontmatter headers and prioritizing updates of existing docs over creating new ones.

Core Features & Use Cases

Metadata header enforcement for all docs.
Guidance to update before creating new docs across technical decisions, API flows, changelogs, READMEs, or guides.
Standardized templates and structure, including mermaid diagrams and changelog conventions.

Quick Start

Review an existing document, ensure a YAML frontmatter header, and update metadata before creating any new docs.

Frequently Asked Questions about documentation

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

FAQPage Schema

How do I enforce YAML frontmatter headers in project documentation?▼

To enforce YAML frontmatter headers in project documentation, you apply a standardized metadata structure at the top of each file. This ensures consistent tracking of document attributes and enforces update history conventions.

What is the best way to manage changelog conventions and architecture guides?▼

Managing changelog conventions and architecture guides is best handled by applying standardized templates that include mermaid diagrams and structured update histories. This prioritizes updating existing docs over creating new ones.

When should I update existing documentation instead of creating a new file?▼

You should update existing documentation instead of creating a new file when reviewing technical decisions, API flows, or guides. This approach maintains organized docs by preventing duplication and enforcing metadata-driven updates.

Can I use mermaid diagrams and metadata in developer docs and READMEs?▼

Yes, you can use mermaid diagrams and metadata in developer docs and READMEs. The system enforces a standardized template structure that integrates mermaid diagrams and YAML frontmatter across all project documentation types.

How do I standardize API decision documentation across a project?▼

To standardize API decision documentation, you enforce a structured template system with YAML frontmatter headers and changelog conventions. This guides how to structure files and ensures metadata is updated before new docs are created.