Skip to main content

Introduction

Welcome to the documentation for [Project Name].

This site is built with Docusaurus and contains all project documentation: context, requirements, planning, architecture, decisions, and prototype references.

Documentation Structure​

FolderContents
00-contextProject overview, user personas, glossary, and out-of-scope items
01-requirementsFeature requirements organized by feature slice
02-planningPhased roadmap and role mapping
03-architectureCore architecture, interface/data contracts, database, diagrams, ops, and security
04-decisionsArchitectural Decision Records (ADRs) and decision log
05-prototypePrototype brief, design direction, and prototype artifacts

Update the links above once you rename the category folders for your project.

How to Use This Template​

  1. Run the template setup — replace [Project Name] and update docusaurus.config.ts/README.md before writing any content (see the checklist below, or run /docs-setup).
  2. Start with 00-context/ — fill in the project overview, personas, and glossary before writing requirements.
  3. Write requirements in 01-requirements/ — use f-000-feature-template.md as the starting point for each new feature.
  4. Plan phases in 02-planning/ — map features to phases, define roles, and track risks.
  5. Record decisions in 04-decisions/ — use the ADR Template for every significant architectural choice.
  6. Design the architecture in 03-architecture/ — fill in the solution design, interface/data contract standards, database schema, and security posture.
  7. Prototype key flows in 05-prototype/ — place your prototype artifact (Pencil .pen, draw.io, Stitch link, or ASCII mockup) and document it with the brief and design direction.
  8. Set up work items in your tracker — configure Jira (or your tracker of choice) using the epic and story field patterns documented in your team's tracker setup.

Using an AI coding agent? Steps 0–7 above each have a matching guided slash command (/docs-setup, /docs-context, /docs-requirements, /docs-planning, /docs-decisions, /docs-architecture, /docs-prototype, /docs-work-items) available for Claude Code, opencode, and GitHub Copilot that interviews you and writes the answers into these docs for you. Run /docs-next anytime to check section-by-section completion and get the next recommended command. See the README's command table for where each agent's commands live.

Template Setup Checklist​

Run /docs-setup to handle the first two items below for you.

  • Replace [Project Name] in every file (use search-and-replace across docs/).
  • Update docusaurus.config.ts with your project name, URL, and org.
  • Replace static/img/logo.svg and static/img/favicon.ico with your branding.
  • Delete examples/ when you no longer need the reference work items.
  • Update all YYYY-MM-DD dates as documents are filled in.