writing-design-plans

Automates creation of software design documents with structured phases and summary/glossary generation.

8|1|Updated Feb 25, 2022
One-click install
npx skills add https://github.com/ayubun/dotfiles --skill writing-design-plans-ayubun
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-design-plans
Source: https://github.com/ayubun/dotfiles/tree/main/configs/opencode/skills/ed3d-plan-and-execute/writing-design-plans
Command: npx skills add https://github.com/ayubun/dotfiles --skill writing-design-plans-ayubun

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the challenge of creating comprehensive design documents by guiding the user through structured phases and automating content generation.

Core Features & Use Cases

  • Structured Design Phases: Helps users break down complex designs into manageable, sequential phases.
  • Automated Content Generation: Generates Summary and Glossary sections to complete the document.
  • Use Case: Ideal for software development teams looking to create detailed design plans that align with project requirements and best practices.

Quick Start

Run the writing-design-plans skill to complete your design document for the new feature 'user-authentication'.

Frequently Asked Questions about writing-design-plans

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

FAQPage Schema
How do I automate software design document creation for architectural decisions?

Automated documentation structures the software design process into discrete phases to generate design documents, capturing architectural decisions and component interactions while automatically creating summary and glossary sections.

What is phase-based planning for software design documents?

Phase-based planning breaks complex software designs into manageable, sequential phases to guide the creation of detailed design plans, ensuring documentation aligns with project requirements and best practices.

How do I structure a design document to cover implementation phases and component interactions?

Structuring a design document involves dividing the process into discrete phases that document component interactions and implementation phases, leveraging existing codebase patterns to guide the architectural design.

Does automated design documentation require human validation?

Automated design documentation requires human validation specifically for acceptance criteria, ensuring the generated summary, glossary, and architectural components meet project standards before finalizing the document.

Can I use existing codebase patterns to guide automated content generation?

Automated content generation uses existing codebase patterns to guide the software design process, automatically generating summary and glossary sections while structuring architectural decisions into discrete phases.

What is the best way to write detailed design plans for new software features?

Writing detailed design plans is best achieved by breaking down complex designs into sequential phases, automating summary and glossary generation, and validating acceptance criteria against project requirements.