Design Doc

For when you're asked to write a design doc or specification, especially after a brainstorm or feature design session.

tools-only 3f5460e 3 files · 2.1 KB Updated 7 repo stars

File contents

Design Doc

This skill is for when you're asked to write a design document or design specification, especially after a brainstorm or feature design session.

Design docs go into the docs/ directory in the project root. Create the folder if it doesn't exist. The design doc is in Markdown. Choose a concise, relevant name yourself.

Content

  • Be concise.
  • Don't include too many code examples, unless necessary because they contain valuable details uncovered during the brainstorm or design session.

tools-only/X-Skills/tree/main/content-creation/003-name-skill_2272bf3e commit 3f5460e72e

Frequently asked questions

npx skillmds add tools-only/design-doc