Skip to main content
PreparationZone Logo
PreparationZone
Back to Fundamentals

Fundamentals · Easy · Free

What belongs in README vs wiki vs code comments?

FresherFundamentalsSoftware Engineering & Tools
Model answer

Where docs live

For What belongs in README vs wiki vs code comments, interviewers listen for a crisp definition, how the pieces interact in a real system, and one trade-off or failure mode you have seen or would guard against.

  • README: run locally in 5 minutes
  • Wiki/Notion: architecture decisions
  • Code comments: why, not what
Stale docs worse than none—date your ADRs.