document-guideline

Enforce documentation standards across design docs, READMEs, interfaces, and test cases.

1|Updated Dec 17, 2025
One-click install
npx skills add https://github.com/fengqiyu0317/assassyn --skill document-guideline-fengqiyu0317
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-guideline
Source: https://github.com/fengqiyu0317/assassyn/tree/main/assassyn-master/.claude/skills/document-guideline
Command: npx skills add https://github.com/fengqiyu0317/assassyn --skill document-guideline-fengqiyu0317

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Instructs AI agents on maintaining comprehensive documentation standards across design docs, folder READMEs, source code interfaces, and test cases, ensuring consistency and automated enforcement.

Core Features & Use Cases

  • Enforces folder README.md presence to clarify folder purpose and contents
  • Ensures each source file has a corresponding MD document outlining external public interfaces and internal helpers
  • Enables cross-skill guidance, providing standards used by plan-guideline and milestone skills to drive documentation-first workflows
  • Validates documentation quality through lints and self-review (dogfooding) within the skill ecosystem

Quick Start

Run the pre-commit hook to enforce documentation standards on every commit.

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 for design docs and folder READMEs?

You can enforce documentation standards by applying guidelines that mandate folder README.md presence and source file markdown interfaces, validating them through a pre-commit linting process before implementation.

Can I use pre-commit hooks to validate source code interfaces and test cases?

Yes, pre-commit hooks validate source code interfaces and test documentation coverage by enforcing linting checks against established documentation guidelines during the commit workflow.

What is the best way to maintain documentation-first workflows in AI development?

Maintaining documentation-first workflows requires instructing AI agents to produce design docs and interface documentation before implementation, integrating with planning skills to drive consistency.

Does this documentation guideline work with plan-guideline and milestone skills?

Yes, this guideline provides cross-skill guidance and standards used by plan-guideline and milestone skills to ensure documentation compliance across the AI planning and development ecosystem.

How do I ensure every source file has a corresponding markdown document?

To ensure each source file has a corresponding markdown document, define guidelines requiring MD files that outline external public interfaces and internal helpers, validated by pre-commit lints.

What are the limitations of automated documentation linting?

Automated documentation linting validates structural compliance and file presence for READMEs and interfaces, but may not assess the semantic quality or accuracy of the written content itself.