role-docs

Audit repository documentation against CLAUDE.md, AGENTS.md, and README badge standards.

Updated Feb 26, 2026
One-click install
npx skills add https://github.com/jinglemansweep/agent-resources --skill role-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: role-docs
Source: https://github.com/jinglemansweep/agent-resources/tree/main/plugins/jplan/skills/role-docs
Command: npx skills add https://github.com/jinglemansweep/agent-resources --skill role-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation conventions and quality gates for ensuring consistent, high-quality project documentation across repositories.

Core Features & Use Cases

  • Enforces README badge rules, contributor guidelines, and standardized documentation sections.
  • Guides auditing of documentation files across repositories (CLAUDE.md, AGENTS.md, CHANGELOG.md, etc.).
  • Supports creating and maintaining documentation conventions during onboarding and maintenance.

Quick Start

Audit the repository's documentation and apply the standard conventions to existing files to achieve compliance.

Frequently Asked Questions about role-docs

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

FAQPage Schema
How do I enforce documentation conventions and README badge rules across multiple repositories?

To enforce documentation conventions across repositories, you need an auditing tool that checks for required headings, sections, and README badges. This skill applies standardized quality gates to project files like CLAUDE.md, AGENTS.md, and CHANGELOG.md to ensure consistent compliance.

What is the best way to audit markdown documentation for missing contributor guidelines and standardized sections?

The best way to audit markdown documentation is to apply automated convention checks that scan repository files for missing required headings and contributor guidelines. This process evaluates existing README structures and enforces badge standards to achieve full project compliance.

Can I use automated documentation checks during project onboarding and maintenance?

Yes, you can use automated documentation checks during project onboarding and maintenance. The auditing process integrates into these workflows to guide the creation and enforcement of standardized markdown sections, ensuring documentation quality is maintained continuously.

Does enforcing documentation quality require adherence to specific repository files like CLAUDE.md and AGENTS.md?

Enforcing documentation quality requires strict adherence to project-specific files like CLAUDE.md, AGENTS.md, and README badge standards. The auditing mechanism validates existing repository documentation against these defined guidelines to guarantee structural consistency.

What are the limitations of using standardized documentation conventions for repository maintenance?

The main limitation of standardized documentation conventions is the strict dependency on predefined repository files and badge rules. If a project lacks established CLAUDE.md or AGENTS.md guidelines, the auditing process cannot effectively enforce the required structural compliance.