Skip to content

Docs Folder Structure ​

A project's docs live at docs/, the main entry point and the wiki's root. Each folder has one job.

Why ​

Every folder answers one question, so a reader knows where a fact belongs before looking.

Root ​

  • overview.md - what the product is, functional only.
  • architecture.md - how it is built: the decisions, layers, libraries and conventions.
  • Nothing feature-specific or work-tracking sits at the root.

Knowledge ​

  • docs/features/ - the feature docs: the product as decided (Feature Template).
  • docs/<app>/ - in a workspace with several apps, each app's docs, shaped like the root: its overview, architecture and features (Application Template).
  • docs/workspace/ - the cross-cutting concern docs as flat files: authentication.md, design-system.md, testing.md and the like (Workspace Template).

Work ​

Records ​

All records sit together under docs/records/, one group in the wiki with an overview.md listing them. Each record folder is a dated trail, written as things happen. Its shape lives in its own standard.

  • docs/records/log/ - everything the director says, one file per day (Request Log).
  • docs/records/activity/ - the work done, one file per day (Activity Log).
  • docs/records/playtests/ - one file per playtest of a game (Playtest Files).
  • docs/records/user-tests/ - one file per session with real users (User Test Files).
  • docs/records/changelog/ - one page per version (Changelog Per Version).
  • Any other dated trail a project keeps joins them under docs/records/, never at the docs root.