cmd-document

Generate bug fix documentation and pull request descriptions from issue artifacts.

Updated May 12, 2026
One-click install
npx skills add https://github.com/HillBombCreations/vivreal-skills --skill cmd-document
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: cmd-document
Source: https://github.com/HillBombCreations/vivreal-skills/tree/main/vivreal-workflow/skills/cmd-document
Command: npx skills add https://github.com/HillBombCreations/vivreal-skills --skill cmd-document

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the creation of documentation and pull request descriptions for completed bug fixes, streamlining the process and reducing manual work.

Core Features & Use Cases

  • Automated Documentation: Generates RESOLUTION.md and pr-description.md files for bug fixes.
  • Artifact Reading: Reads issue, research, plan, and review documents for the given bug slug.
  • Metrics Recording: Records and appends documentation metrics to metrics.md.
  • PR Suggestion: Suggests next steps for pulling the fix into production.

Quick Start

Dispatch the documenter agent for a bug fix by running: /document <slug>

Frequently Asked Questions about cmd-document

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

FAQPage Schema
How do I automate bug fix documentation and PR creation?

Automate bug fix documentation by dispatching the documenter agent with a bug slug to read existing artifacts and generate RESOLUTION.md and pr-description.md files automatically.

What is the process for generating pull request descriptions from bug fix artifacts?

Generating pull request descriptions involves reading issue, research, plan, and review documents for a specific bug slug, then automatically writing the PR description and documentation files.

Can I automatically record metrics for completed bug fix documentation?

Recording metrics for bug fix documentation is supported by appending generated documentation metrics directly to a metrics.md file during the automated PR creation workflow.

What documents are required to generate a RESOLUTION.md file for a bug fix?

Generating a RESOLUTION.md file requires reading existing issue, research, plan, and review documents associated with the specific bug slug provided to the workflow.

Does the automated documentation workflow suggest next steps for pulling a fix into production?

The automated documentation workflow suggests next steps for pulling a completed bug fix into production after successfully generating the required documentation and PR descriptions.

How do I trigger the documenter agent for a specific bug slug?

Trigger the documenter agent for a specific bug slug by running the slash command /document followed by the bug slug to process artifacts and generate documentation.