design-doc

Generate concise design documents for proposed technical changes.

1.2k|146|Updated Mar 22, 2024
One-click install
npx skills add https://github.com/marin-community/marin --skill design-doc-marin-community
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: design-doc
Source: https://github.com/marin-community/marin/tree/main/.agents/skills/design-doc
Command: npx skills add https://github.com/marin-community/marin --skill design-doc-marin-community

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you create clear, focused design documents that effectively communicate a proposed change, its rationale, and its implications without unnecessary detail.

Core Features & Use Cases

  • Structured Document Generation: Follows a strict template for problem definition, goals, proposed solutions, implementation outlines, and future considerations.
  • Concise Communication: Emphasizes brevity and clarity, using file references and minimal code snippets to convey core ideas.
  • Use Case: When proposing a new feature for a software project, use this Skill to generate a design document that outlines the problem, the proposed technical approach, and the trade-offs involved, ensuring all stakeholders have a shared understanding.

Quick Start

Use the design-doc skill to write a design document for tracking step execution time in the executor framework.

Frequently Asked Questions about design-doc

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

FAQPage Schema
How do I write a concise software design document for a proposed technical change?

To write a concise software design document, define the problem, goals, solution approach, and trade-offs. Use minimal code snippets and file:line references to keep the proposal readable and focused on core technical implications.

What should a technical proposal include for stakeholder communication?

A technical proposal should include a structured problem definition, clear goals, an implementation outline, and future considerations. This ensures stakeholders share a complete understanding of the proposed change and its rationale.

How do I structure a design document to balance detail and readability?

Structure a design document by adhering to strict length and content guidelines. Emphasize concise communication by using file references and illustrative code snippets rather than extensive text to convey core ideas.

When do I need to generate a spec for a new software feature?

Generate a spec for a new software feature when you need to communicate a proposed change, its rationale, and its implications. It helps outline the technical approach and trade-offs without unnecessary detail.

What is the best way to outline implementation steps in a technical proposal?

The best way to outline implementation steps in a technical proposal is to focus on the solution approach and implementation outline. Include trade-offs and reference code using file:line numbers to maintain brevity.

Does the design-doc skill work without external dependencies?

Yes, the design-doc skill works without external dependencies. It generates readable design documents independently, focusing strictly on problem definition, goals, and solution approach without requiring additional modules.