reviewable-design-doc

Generate and govern reviewable design documents as HTML with feedback ingestion.

276|13|Updated May 17, 2026
One-click install
npx skills add https://github.com/u-ichi/reviewable-html-workbench --skill reviewable-design-doc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: reviewable-design-doc
Source: https://github.com/u-ichi/reviewable-html-workbench/tree/main/skills/reviewable-design-doc
Command: npx skills add https://github.com/u-ichi/reviewable-html-workbench --skill reviewable-design-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Design teams often struggle to harmonize feedback across documents and tools, causing context loss and slow iteration. This skill organizes requirements, architecture, decisions, and open items into a structured design document that can be rendered as a self-contained HTML bundle. It also supports ingesting agent replies back into the document model and emitting targeted HTML comments to close the feedback loop.

Core Features & Use Cases

  • Structure content into blocks (requirements, constraints, architecture, alternatives, decisions, open issues) that map to a renderer-friendly HTML model.
  • Ingest feedback and reflect clear agent replies in the same HTML comment threads.
  • Render, validate, preview, and share a final HTML bundle with embedded context.

Quick Start

Create a new design document model and render it into a review-ready HTML bundle.

Frequently Asked Questions about reviewable-design-doc

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

FAQPage Schema
How do I create reviewable design documents with structured requirements and architecture?

Reviewable design documents are created by structuring content into blocks for requirements, constraints, architecture, and decisions. This approach maps the content to a renderer-friendly HTML model, allowing you to render, validate, and preview a self-contained HTML bundle for review.

What is the best way to ingest feedback into a design document model?

Ingesting feedback into a design document model involves capturing reviewer replies and reflecting them as targeted HTML comments. This process closes the feedback loop by attaching agent replies directly into the structured document blocks within the rendered HTML bundle.

How does HTML rendering work for architectural notes and decision logs?

HTML rendering for architectural notes and decision logs works by applying a document-model that organizes alternatives, decisions, and unresolved items. The system renders these structured blocks into a self-contained HTML bundle, enabling reviewers to preview and validate the design content.

Can I use a CLI workflow to validate and preview design documentation?

Yes, you can use a full CLI workflow to validate and preview design documentation. The workflow drives rendering and validation commands, ensuring your structured design documents are checked and rendered into a review-ready HTML bundle before sharing.

Does this approach support tracking open issues and unresolved items in design reviews?

Yes, tracking open issues and unresolved items in design reviews is supported through dedicated content blocks. The document-model organizes these open issues alongside architecture and decisions, ensuring they are visible and manageable within the rendered HTML feedback bundle.

What are the limitations of managing design reviews through a structured HTML document?

Managing design reviews through a structured HTML document requires content to be strictly organized into predefined blocks like requirements and decisions. If your design process relies on unstructured freeform text rather than block-based metadata, this rendering model may constrain your workflow.