defining-design-doc

Orchestrate Design Doc creation from Design Briefs through PR release.

Updated Aug 18, 2025
One-click install
npx skills add https://github.com/masa-codehub/gemini_agent --skill defining-design-doc
Or copy as Structured Prompt for Agentโ–ผ
Please help me install this Agent Skill.
Skill: defining-design-doc
Source: https://github.com/masa-codehub/gemini_agent/tree/main/.gemini/skills/defining-design-doc
Command: npx skills add https://github.com/masa-codehub/gemini_agent --skill defining-design-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

๐Ÿ’ก This Skill includes references (resource) components.

What problem does it solve?

Orchestrates the creation of Design Docs for new features or major changes. Scopes the design using Design Briefs and delegates drafting to ensure high-quality documentation.

Core Features & Use Cases

  • Scoping design tasks via Design Brief to define goals and constraints
  • Drafting and auditing the Design Doc with quality checks
  • Release-ready outputs via PR and review workflow

Quick Start

Activate the scoping-design-tasks to create a Design Brief, then run drafting-design-doc to generate the Design Doc, and finally open a PR with the result.

Frequently Asked Questions about defining-design-doc

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

FAQPage Schema
How do I create a design doc for a new software feature?โ–ผ

Drafting a design doc begins by scoping goals and constraints with a Design Brief, then delegating the drafting and auditing phases to generate review-ready documentation. This workflow ensures clear objectives and traceable design language for pull requests.

What is a design brief and when do I need it for documentation?โ–ผ

A design brief defines the goals and constraints of a new feature or major change. You need it during the scoping phase to establish clear objectives before drafting the actual design doc and proceeding to the pull request release.

How do I audit a design doc before opening a pull request?โ–ผ

Auditing a design doc involves running quality checks against the initial Design Brief to satisfy requirements for clear objectives and traceable design language. This ensures the documentation is review-ready and properly formatted for the PR release workflow.

Can I use DDD modeling guidelines when drafting design docs?โ–ผ

Yes, you can optionally reference DDD Modeling guidelines during the drafting and auditing phases. This helps structure the design doc to ensure traceable design language and clear objectives for major system changes.

What's the best way to manage design documentation from scoping to release?โ–ผ

The best way to manage design documentation is orchestrating an end-to-end workflow: scope with a Design Brief, draft the Design Doc, perform quality audits, and output release-ready artifacts via a pull request. This ensures traceable design language throughout.

Do I need a design brief to generate a design doc?โ–ผ

Yes, a Design Brief is required to scope the design task and define goals and constraints. It serves as the primary input for drafting the Design Doc, ensuring the final documentation satisfies requirements for clear objectives and review-ready quality.