documenter

Generate RESOLUTION.md and PR descriptions from research, plan, and review artifacts.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the generation of documentation for resolved bugs and features, saving time and reducing manual errors in the documentation process.

Core Features & Use Cases

  • Documentation Generation: Automatically creates RESOLUTION.md and PR descriptions from completed artifacts.
  • Metrics Reporting: Collects and reports metrics on the development process.
  • Use Case: After a fix is implemented and approved, the Documenter skill can be used to produce documentation, ensuring that future engineers have all the necessary information.

Quick Start

Generate documentation for the bug/feature by using the command 'documenter generate <slug>'.

Frequently Asked Questions about documenter

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

FAQPage Schema
How do I automatically generate PR descriptions from bug and feature artifacts?

You can automatically generate PR descriptions and RESOLUTION.md files by processing completed research, plan, and review artifacts through the documenter workflow. Run 'documenter generate <slug>' to produce standardized documentation for resolved bugs and features.

What's the best way to document resolved bugs in a CI/CD pipeline?

To document resolved bugs in a CI/CD pipeline, apply automated documentation generation to your continuous integration and delivery workflows. This creates RESOLUTION.md files and PR descriptions directly from completed development artifacts, ensuring future engineers have necessary context.

Can I collect development process metrics while generating documentation?

Yes, you can collect and report metrics on the development process alongside automated documentation generation. The skill captures process data from bug tracking and feature development artifacts to produce both documentation and metrics reporting.

Does automated documentation generation work without external dependencies?

Automated documentation generation works without external dependencies, but requires processing and formatting capabilities within your environment. The skill operates standalone to transform research, plan, and review artifacts into structured RESOLUTION.md files and PR descriptions.

When do I need to generate RESOLUTION.md files for software development workflows?

You need to generate RESOLUTION.md files after a bug fix or feature implementation is completed and approved. This ensures future engineers have all necessary resolution information by automatically capturing details from research, plan, and review artifacts.

What are the limitations of automated bug tracking documentation generation?

Automated bug tracking documentation generation requires completed research, plan, and review artifacts as input, and depends on processing and formatting capabilities. It cannot generate documentation from incomplete or missing development artifacts in your workflow.