update-design

Record design decisions from conversations into DESIGN.md with dated changelog entries.

Updated May 29, 2021
One-click install
npx skills add https://github.com/hikch/dotfiles --skill update-design-hikch
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-design
Source: https://github.com/hikch/dotfiles/tree/main/.claude/skills/update-design
Command: npx skills add https://github.com/hikch/dotfiles --skill update-design-hikch

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Explicitly captures and records design decisions from the current conversation into DESIGN.md.

Core Features & Use Cases

  • Read and extract decisions from dialogue and update DESIGN.md sections accordingly.
  • Append a dated changelog entry to DESIGN.md to track decision history.
  • Maintain cross-reference consistency between Overview, Architecture, Implementation Plan, and TODOs.

Quick Start

Update DESIGN.md with decisions from the current conversation.

Frequently Asked Questions about update-design

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

FAQPage Schema
How do I capture design decisions from a conversation and update a design doc?

To capture design decisions and update a design doc, this Skill extracts dialogue from your current conversation and appends a dated changelog entry directly into DESIGN.md. It reads existing content and modifies sections like Overview and Architecture to maintain consistency.

What is the best way to maintain cross-reference consistency in a DESIGN.md file?

Maintaining cross-reference consistency in a DESIGN.md file involves linking related sections such as Architecture, Implementation Plan, and TODOs. This Skill automatically aligns these sections when recording new design decisions from your active conversation.

How to track architectural decision history in markdown documentation?

Tracking architectural decision history in markdown documentation is done by appending dated changelog entries. This Skill automatically extracts decisions from your dialogue and adds timestamped records to DESIGN.md for accurate historical tracking.

Can I update implementation plans and TODOs directly from my chat dialogue?

Yes, you can update implementation plans and TODOs directly from chat dialogue. This Skill processes your conversation, identifies relevant decisions, and reflects them across the corresponding sections within your DESIGN.md file.

Does updating a changelog manually work better than using a design doc automation tool?

Updating a changelog manually risks missing cross-reference consistency between sections like Architecture and TODOs. Using a design doc automation tool ensures dated changelog entries and implementation plans are systematically extracted and synchronized from conversations.

Why does my DESIGN.md lose cross-reference consistency after team collaboration?

Your DESIGN.md loses cross-reference consistency after team collaboration when decisions are not systematically recorded. This Skill prevents this by extracting dialogue decisions and aligning the Overview, Architecture, and Implementation Plan sections automatically.