user-guide-update

Update user guides from implementation-summary, verification-report, and design-note artifacts.

Updated Mar 22, 2026
One-click install
npx skills add https://github.com/Burburton/amazing_agent_specialist --skill user-guide-update
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: user-guide-update
Source: https://github.com/Burburton/amazing_agent_specialist/tree/main/templates/pack/full/.opencode/skills/docs/user-guide-update
Command: npx skills add https://github.com/Burburton/amazing_agent_specialist --skill user-guide-update

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation drift and misalignment between user guides and implemented features slow adoption and generate support overhead.

Core Features & Use Cases

  • Align user guides with implementation-summary, verification-report, and design-note to ensure accuracy.
  • Produce a formal user-guide-sync-report capturing consumed_artifacts, touched_sections, api_changes, and image_verification.
  • Enforce cross-document consistency and verify runnable examples across docs.

Quick Start

Update the user guide by consuming upstream artifacts and generate a user-guide-sync-report.

Frequently Asked Questions about user-guide-update

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

FAQPage Schema
How do I keep user guides synchronized with live features and upstream changes?▼

You can synchronize user guides by consuming verified upstream artifacts like implementation summaries and verification reports to update target sections, API references, and workflow guides for cross-document consistency.

What causes documentation drift between user guides and implemented features?▼

Documentation drift happens when user-facing guides are not updated alongside implemented features, causing misalignment that slows adoption and generates support overhead.

How do I verify runnable examples and API changes across user-facing documentation?▼

Verify runnable examples and API changes by enforcing cross-document consistency, checking touched sections against upstream design notes, and producing a user-guide-sync-report detailing example verification status.

Can I generate a sync report capturing consumed artifacts and touched sections for user guides?▼

Yes, you can generate a formal user-guide-sync-report that captures consumed artifacts, touched sections, API changes, and image verification to provide an evidence-based status of documentation alignment.

What is the best way to align API references with implementation summaries and verification reports?▼

The best way to align API references is to update them based on verified upstream artifacts, targeting specific user-guide sections to ensure accuracy and cross-document consistency.

Do I need design notes and verification reports to update workflow guides accurately?▼

Yes, consuming verified upstream artifacts like design notes and verification reports is required to accurately update workflow guides and maintain evidence-based documentation status.