Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 

Repository files navigation

Spec-Driven Development

Get started

Tell AI:

Apply https://raw.githubusercontent.com/brillout/sdd/refs/heads/main/sdd.md

Note

https://raw.githubusercontent.com/brillout/sdd/refs/heads/main/sdd.md is the raw link of the ssd.md file of this repository.

What does it do?

  • AI generates .spec.md for each source code file:
    One-sentence description of what this file/directory does.
    
    ## TLDR
    
    - Code does this
    - And that
    - ...
    
    ## Problems
    
    List of non-obvious problems.
    
    ## Decisions
    
    List of non-obvious decisions.
    
    ## Facts
    
    List of non-obvious uncommon knowledge.
    
    ## Flows
    
    List of all high-level flows.
  • AI will maintain these .spec.md files

Why?

It enables you to:

  • When AI makes a change, quickly read the modified business logic instead of reading code
  • Quickly navigate unfamiliar code

How does it work?

Read the sdd.md file — it's small.

See also

About

Spec-Driven Development

Resources

Stars

1 star

Watchers

1 watching

Forks

Contributors