Does it include automated linting?

Yes, it enforces quality gates by running pre-commit hooks, which typically cover markdownlint and other documentation-related formatting checks.

What documentation files does this skill support?

It supports a wide range of files including README.md, CLAUDE.md, AGENTS.md, .github/copilot-instructions.md, CONTRIBUTING.md, CHANGELOG.md, and Cursor (.mdc) rules.

How does it handle repository badges?

The skill mandates GitHub Actions workflow status badges and license badges, ensuring they are placed correctly immediately after the top-level heading.

How does this skill interact with AI agents?

It is specifically designed to be loaded by developer agents to ensure that when they update code, they also maintain high-quality, synchronized documentation and instructions.

Can it verify if documentation is accurate?

Yes, it follows a strict workflow to audit the codebase and cross-reference documentation against actual implementation to ensure no features are invented or misstated.

Technical Documentation & Quality Gates

Name: Technical Documentation & Quality Gates
Author: jinglemansweep

byjinglemansweep

0•

Learning & Documentation

Enforces strict documentation standards and quality gates across repository-wide markdown files and AI agent instructions.

The role-docs skill provides a comprehensive framework for managing technical documentation, ensuring consistency across READMEs, AI agent instructions (CLAUDE.md, AGENTS.md), and changelogs. It automates the verification of repository features against actual source code, mandates specific badge placements for CI/CD and licensing, and integrates quality gates like pre-commit hooks to maintain production-grade documentation standards throughout the development lifecycle.

Key Features

010 GitHub stars

02Cross-synchronization of AI agent instruction files like CLAUDE.md and .cursor/rules

03Integrated quality gates using pre-commit hooks and markdownlint

04Mandatory GitHub Actions and License badge placement enforcement

05Adherence to 'Keep a Changelog' format and Semantic Versioning references

06Automated codebase auditing to ensure documentation reflects current implementation

Use Cases

01Standardizing documentation across a multi-repo organization with consistent badges and structures

02Auditing legacy projects to remove stale documentation and update outdated feature descriptions

03Maintaining synchronized instructions for various AI agents (Claude, Copilot, Cursor) within a single project

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jinglemansweep/agent-resources role-docs

For use in Claude.ai and ChatGPT

Key Features

010 GitHub stars

02Cross-synchronization of AI agent instruction files like CLAUDE.md and .cursor/rules

03Integrated quality gates using pre-commit hooks and markdownlint

04Mandatory GitHub Actions and License badge placement enforcement

05Adherence to 'Keep a Changelog' format and Semantic Versioning references

06Automated codebase auditing to ensure documentation reflects current implementation

Use Cases

01Standardizing documentation across a multi-repo organization with consistent badges and structures

02Auditing legacy projects to remove stale documentation and update outdated feature descriptions

03Maintaining synchronized instructions for various AI agents (Claude, Copilot, Cursor) within a single project

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jinglemansweep/agent-resources role-docs

For use in Claude.ai and ChatGPT