modules-readme

Create and validate ADHD Framework module README files using canonical templates.

Updated Feb 1, 2026
One-click install
npx skills add https://github.com/AI-Driven-Highspeed-Development/adhd_framework_v3 --skill modules-readme
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: modules-readme
Source: https://github.com/AI-Driven-Highspeed-Development/adhd_framework_v3/tree/main/modules/dev/instruction_core/data/skills/modules-readme
Command: npx skills add https://github.com/AI-Driven-Highspeed-Development/adhd_framework_v3 --skill modules-readme

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

The Module README Authoring workflow provides a standardized, repeatable process to create clear, consistent, and high-quality READMEs for ADHD Framework modules.

Core Features & Use Cases

  • Enforces a consistent section structure and tone for module READMEs
  • Provides templates and guidance for cross-linking, requirements, and validation
  • Supports quickstart examples and canonical templates for rapid authoring
  • Use Case: When documenting a new module, this workflow guides the author to produce a complete README that adheres to project standards.

Quick Start

Follow the required section order, templates, and tone to generate a complete module README.md for a given ADHD Framework module.

Frequently Asked Questions about modules-readme

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

FAQPage Schema
How do I create a consistent module README for the ADHD Framework?▼

Module README validation checks the required section structure, tone consistency, cross-linking accuracy, and template adherence to ensure your documentation meets ADHD Framework quality standards.

What's the best way to update documentation after API changes in my modules?▼

No, this workflow specifically validates READMEs for ADHD Framework modules using a canonical template, required section order, and tone rules, rather than processing generic standalone documentation files.

How do I validate module README structure and cross-linking?▼

To create a consistent module README, follow the standardized section order, apply the canonical template, and use the provided tone rules to ensure your documentation meets project quality and cross-linking requirements.

Does this README template work for generic documentation or just ADHD Framework modules?▼

Updating documentation after API changes involves re-running the README validation workflow to verify that section structure, cross-links, and quickstart examples still align with the canonical template and updated module requirements.