Skills
.Work. You
Rest

document-guideline

Community

Enforce top-tier project documentation standards.

Content & Communication#workflow#linting#documentation#readme#pre-commit#design-docs
AuthorMAdrid1011
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 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: document-guideline
Download link: https://github.com/MAdrid1011/Zircon-VLIW/archive/main.zip#document-guideline

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.