Skip to content
rd-skills
All skills

documentation-generation

FoundationJIT only

task-agent: change source-owned documentation; review-agent: assess documentation without mutation. Skip tasks requiring neither documentation change nor review.

Group
Engineering workflow
Supported roles
MainAnalysisTaskReview
Source
SKILL.md

Use when

Trigger signals that make this skill the right owner

  • task mode generates or updates README API docs ADR changelog runbook or migration notes
  • review mode assesses documentation accuracy freshness or audience impact

Do not use when

Anti-triggers — as binding as the triggers above

  • no task-local documentation generation decision is required
  • an implementation diff has no separate documentation artifact

Required inputs

What must be supplied before this skill can decide anything

  • current task contract
  • selected primary Professional Skill
  • task-local trigger evidence

Output contract

What this skill owes the next role

  • **Task mode (task-agent):** changed source-grounded documentation artifact; audience and behavior mapping; validation result; proof limits; residual documentation debt
  • **Review mode (review-agent):** documentation verdict; severity-ranked findings; reviewed and unverified scope; proof limits; no mutation

Escalation signals

When this skill must hand the decision back

  • Outdated docs mislead operators users and future implementers

Loaded by

This skill never owns a task. These professionals may pull it in as Layer 3.

Targeted references

Each reference carries its own load condition. None of them enter context by default.

ReferenceLoad whenDo not load whenRequired by
benchmarks-and-patterns.mdbenchmark-patternSource mapping, generation, command safety, or no-docs decisions need depth.A small wording fix has one current authoritative source.TaskReview
checklist.mddecision-checklistDocumentation changes APIs, migrations, operations, examples, or compatibility.No audience-facing behavior or procedure changes.TaskReview
evidence-patterns.mdevidence-patternDocumentation claims need fresh source, generator, or example validation.No factual or no-docs claim awaits proof.TaskReview