rdm-document

Generate user documentation from completed rdm roadmaps with commit cross-referencing.

Updated Feb 4, 2026
One-click install
npx skills add https://github.com/edpaget/bot-showalter --skill rdm-document
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rdm-document
Source: https://github.com/edpaget/bot-showalter/tree/main/.claude/skills/rdm-document
Command: npx skills add https://github.com/edpaget/bot-showalter --skill rdm-document

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the generation of user documentation from a completed rdm roadmap, saving time and ensuring consistency.

Core Features & Use Cases

  • Documentation Generation: Automatically create comprehensive documentation from a completed rdm roadmap.
  • Cross-Referencing: Links phase descriptions to actual code changes for accuracy.
  • User-Friendly Output: Provides structured documentation that is easy for users to follow.
  • Use Case: When you have a completed rdm roadmap, use this Skill to generate detailed documentation that users can reference to understand feature usage and design principles.

Quick Start

Use the rdm-document skill to generate documentation for the roadmap 'project-slug' by running the command 'rdm-document project-slug'.

Frequently Asked Questions about rdm-document

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

FAQPage Schema
How do I generate user documentation from a completed roadmap?

You can generate user documentation from a completed roadmap by running the rdm-document command with your project slug. This automates the creation of structured, user-friendly docs from your roadmap data.

What data do I need to automate roadmap documentation generation?

Automating roadmap documentation generation requires access to your completed roadmap data and commit SHAs. These commit SHAs are essential for cross-referencing phase descriptions with actual code changes.

How does automating documentation from a roadmap ensure accuracy?

Automating roadmap documentation ensures accuracy by cross-referencing phase descriptions with actual code changes using commit SHAs. This links your documentation directly to the completed software development work.

Can I link roadmap phases to code changes automatically?

Yes, you can link roadmap phases to code changes automatically by processing commit SHAs alongside your roadmap data. This cross-referencing ensures your generated documentation accurately reflects development updates.

What is the best way to structure user documentation from software development roadmaps?

The best way to structure user documentation from software development roadmaps is to automate the process using rdm-document. It outputs structured, user-friendly documentation that details feature usage and design principles.

Do I need a completed roadmap to generate user documentation?

Yes, you need a completed rdm roadmap to generate user documentation. The Skill processes finished roadmap data to ensure the generated documentation accurately reflects the final features and design principles.