Skip to content

backlog.md

Latest commit

 

History

History
49 lines (49 loc) · 3.32 KB

backlog.md

File metadata and controls

49 lines (49 loc) · 3.32 KB
Raw
  • Backlog README
    • This file is a tab-indented Markdown outline — one TAB per level. The format is designed for Bike 2 (https://www.hogbaysoftware.com/bike/releases2/), Hog Bay Software's outliner that uses this Markdown format (currently in beta). Any editor works as long as it preserves real tabs; editors that convert tabs to spaces will break the viewer's parser (in VS Code, turn off "Insert Spaces" for this file).
    • The first row that begins with # (the # Project Backlog heading below) starts the parsed backlog. Anything above it is ignored, so this README is free text. If you edit in Bike, it may add a --- metadata header at the very top — leave it alone; the viewer ignores it. Never put backlog content above the heading.
    • Item IDs are PREFIX-NNN (uppercase prefix + dash + three digits), e.g. FEAT-001. IDs are stable — never renumber. Order items top-to-bottom by priority, and also set the Priority: field on each item so Bike can sort and filter.
    • Suggested prefixes (edit for your project): FEAT (feature), BUG (defect), DOCS (documentation), INFRA (build/tooling/ops), CHORE (maintenance), SETUP (one-time project setup).
    • Status legend: planned, in progress, blocked, dropped, completed.
    • Standard fields per item: Status, Priority, Why, Tasks. Optional: Tags, Refs, Blocked by, Related, Notes.
    • When an item is completed or dropped, CUT it from this file and paste it at the top of backlog-completed.md (below that file's README, newest first) with a Closed: (YYYY-MM-DD) date. For completed items also record the closing commit short hash — since a commit can't contain its own hash, archive with Closing commit: pending and fill in the real hash in a small follow-up commit.
    • Prefer moving items over rewriting. Split oversized items into separate IDs. Use Blocked by: only for real sequencing, not vague relationships.

  • Project Backlog

    • FEAT-001 Wire up the docs viewer for this project
      • Status: in progress
      • Priority: P1
      • Tags:
        • setup
        • tooling
      • Why:
        • The whole workflow is easier to run when the backlog and specs are browsable from a phone over Tailscale.
      • Refs:
        • tools/docs-viewer/README.md
      • Tasks:
        • Copy the template and rename placeholders.
        • Edit the content-dir globs in tools/docs-viewer/src/lib/mdRegistry.ts.
        • Set the project name in tools/docs-viewer/index.html.
        • Run npm install && npm run dev and confirm it loads on the phone.
      • Notes:
        • Replace this whole item once the viewer is working — it's a starter example.
    • FEAT-002 Write the product brief and principles
      • Status: planned
      • Priority: P0
      • Why:
        • An AI assistant works far better when docs/specs/00-product-principles.md and 01-product-brief.md actually describe this product instead of placeholders.
      • Refs:
        • docs/specs/00-product-principles.md
        • docs/specs/01-product-brief.md
      • Tasks:
        • Replace the placeholders in 00-product-principles.md.
        • Replace the placeholders in 01-product-brief.md.
    • BUG-001 Example blocked item
      • Status: blocked
      • Priority: P2
      • Blocked by:
        • FEAT-002
      • Tags:
        • example
      • Why:
        • Demonstrates the blocked pill and the "Blocked only" filter in the viewer. Delete once you have real items.
      • Tasks:
        • Nothing — this is a demonstration row.