document-guideline

Enforce README and Markdown documentation standards across codebases via pre-commit linting.

1|2|Updated Sep 17, 2025
One-click install
npx skills add https://github.com/MAdrid1011/Zircon-VLIW --skill document-guideline-madrid1011
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-guideline
Source: https://github.com/MAdrid1011/Zircon-VLIW/tree/main/.claude/skills/document-guideline
Command: npx skills add https://github.com/MAdrid1011/Zircon-VLIW --skill document-guideline-madrid1011

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The Document Guideline Skill codifies and enforces documentation standards across the project to improve quality, consistency, and maintainability.

Core Features & Use Cases

  • Enforced by pre-commit linting to ensure every folder has README.md and every code file has a companion documentation file
  • Guides AI agents on plan, milestones, and design-first workflows to improve content quality
  • Used by other skills as a reference for documentation expectations during planning and development

Quick Start

Turn on documentation linting in your development workflow and follow the guideline to create or update SKILL.md, README.md in each folder, and companion .md files for source files.

Frequently Asked Questions about document-guideline

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

FAQPage Schema
How do I enforce documentation standards across a codebase using pre-commit hooks?

You can enforce documentation standards by integrating pre-commit linting hooks that verify every folder contains a README.md and each source file has a companion Markdown interface document before allowing commits.

What is the best way to automate README creation for every project folder?

Automating README creation involves applying documentation guidelines during the design and planning workflow, ensuring each directory receives a README.md file to maintain project consistency and clarity.

Do I need a companion Markdown file for every source file to pass documentation linting?

Yes, documentation linting requires a matching companion Markdown interface document for every source file, alongside a README.md in each folder, to satisfy organizational vetting requirements.

Can I integrate documentation vetting into a design-first development workflow?

Yes, you can integrate documentation vetting into a design-first workflow by using guidelines that guide AI agents on milestones and planning, ensuring documentation quality is checked during development.

Why does my pre-commit hook fail when documentation guidelines are enabled?

Pre-commit linting fails when documentation guidelines detect missing README.md files in directories or absent companion Markdown documents for source files, blocking the commit until standards are met.

What limitations exist when enforcing project documentation standards across existing codebases?

Enforcing documentation standards on existing codebases requires generating missing README.md files and companion Markdown documents for all current source files, which can be labor-intensive for large, undocumented projects.