Skip to content

Latest commit

 

History

History
155 lines (118 loc) · 11.5 KB

README.md

File metadata and controls

155 lines (118 loc) · 11.5 KB

Documentation

Orchestrator repo hub — when SDLC-SPDD is installed into a target application, that project gets a leaner hub at docs/sdlc-spdd/README.md (same guides, clearer entry path).

Use this hub to choose the right guide for your current task. If you are new, read the first section in order. If you are already operating a project, jump to the section that matches what you are doing.

Start with the seven onboarding pages below. They are the complete path from install to daily use. The other sections are task-specific reference — open one when its description matches what you are doing.

Core Model

Planning: ROADMAP.md, milestone-*.md, requirements/, requirements/milestones/, session-notes/
        -> inform and summarize
spdd/canvas/ + spdd/memory/ (lessons ledger)  [+ hot .sdlc/ runtime]
        -> govern and remember
code / reviews / sync logs
        -> execute and validate

Use roadmap, milestone, and session-note files for project planning and narrative. Use SDLC-SPDD artifacts for governed execution and durable agent memory.

One mental model everywhere: canvas + contracts are read directly; the lessons ledger (spdd/memory/lessons.jsonl) is the committed record; the Guide DICE graph is the working store queried on demand; SQLite is an optional local cache; captures are staged quietly and accepted at gates.

How do Planning, SPDD, and SDLC fit together in practice? → Three-part operating path

Storage v3 — where memory and context live

Start here for anything about memory, sessions, retrieval, or backends:

Guide Use it when
Storage v3 The canonical storage architecture — ledger, stage-then-accept, Guide working store, parity
Runtime and ledger Day-to-day view: hot briefs under .sdlc/, capture → accept, retrieval commands
Guide flow How phases query the Guide DICE working store (spdd_* MCP tools)
DICE projection runbook Run Guide + Neo4j locally (tag spdd-projection-v3)
Context loading and scaling What loads automatically vs on demand; per-phase budgets
Triple-path context Configure backends (CONTEXT_BACKENDS): git + guide default, sqlite opt-in
Local SQLite index The opt-in regenerable cache (.sdlc/index.sqlite, schema v5)
Diagrams All 14 PlantUML architecture diagrams

Also useful: Quiet mode (product work without T## dogfood gravity), Ops console (Dashboard tab + install / Guide / Jira link & sync / ADF viewer), ADF templates + Vue3 console (product slice in progress).

If You Are New, Read These in Order

  1. First day with SDLC-SPDD — hands-on first session from install to memory capture.
  2. Three-part operating path — how Planning, SPDD, and SDLC work together end to end.
  3. Installing into your project — fresh install, upgrade path, verification, and troubleshooting.
  4. Top useful concepts and commands — Work IDs, canvases, sessions, commands, and prompt patterns.
  5. Maintaining your project — upgrades, memory hygiene, canvas sync, links, and session maintenance.
  6. Storage v3 — where memory lives: ledger, Guide working store, runtime, backends.

Workflow CLI reference (pointer, phase tracking, team registry): agent-context/README.md — installed in target projects at sdlc-spdd/scripts/ with docs under docs/sdlc-spdd/.

Python engine: SDLC Engine — reusable sdlc_engine package; the only lifecycle implementation behind scripts/sdlc.sh.

Local GUIs (experimental ops console + ADF Viewer): Ops console and ADF Viewer.

You can treat the onboarding pages above as the canonical path.

If You Are Installing or Upgrading

Guide Use it when
Installing into your project You are adding SDLC-SPDD to a target application for the first time
Ops console and ADF Viewer You want the experimental localhost UIs (Dashboard, Jira link/sync, install/Guide/viewer)
ADF Viewer You edit checked-in adf/*.adf.json or sync ticket descriptions with Jira
Framework upgrade A target app already has an older SDLC-SPDD install
Cursor usage You only need Cursor command setup and invocation
GitHub Copilot usage You only need Copilot instructions and prompt files
Claude Code usage You only need Claude Code command and CLAUDE.md setup
Agent session scripts You need the setup/resync/capture scripts and target-local runtime commands

If You Are Using This Daily

Three docs work together — each has a distinct job; prompts are not duplicated across them:

Guide Role
Session prompt standard Prompts — copy-paste text for triage, phases, handoff
Daily runbook Rhythm — rules, script sequences, phase checklists
Workflow Sequence — 15-step table and which part owns each step
Three-part operating path Loop — how Planning → SPDD → SDLC connect for a work item

Also useful day to day:

Guide Use it when
Initialization and invocation You need concrete examples for starting work and invoking each SDLC-SPDD skill
Roadmap, milestones, and session notes You use ROADMAP.md, milestone-*.md, and session-notes/ to track project progress
Top useful concepts and commands You want definitions for Work ID, canvas, sync, memory
Cheat sheet You want a one-page PDF-friendly command reference
agent-context/README.md You need workflow CLI, pointer, or team registry detail

If You Are Integrating with Jira or GitHub

Guide Use it when
Jira runbook Create issues in Jira UI, link keys locally, push/pull requirement markdown
Issue sync and branching Tracker-to-branch naming, commit/PR linkage, ops console Issues tab, ADF viewer sync
Jira-compatible requirements format YAML frontmatter, Related Work, and validation for requirements
Analysis phase scope validation Scope Lock before analysis generation
Ops console Configure integrations (.sdlc/integrations-config.json), link issues, sync from the GUI

If You Are Contributing or Editing Docs

Guide Use it when
CONTRIBUTING.md You are changing scripts or documentation — includes orchestrator vs target paths and a consistency checklist
Command specs You are editing Cursor/Copilot/Claude commands via spec/commands/
Contributing skills You are adding or updating #SkillName files under harness/skills/
Ops console and ADF Viewer Two local GUIs (:5051 / :5050), tabs, and Guide integration map
MCP Guide for agents You query Guide from CLI or delegate spdd_* MCP tools during analysis/code phases
DICE projection runbook You run the local Guide + Neo4j stack for dogfood or retrieval tests
Local SQLite index Zero-install .sdlc/index.sqlite query cache; opt-in, fully regenerable from the ledger
Jira ADF + requirements sync Exact Cloud ADF / Server wiki payloads; requirements as source of truth for Jira + REASONS
Kasana Agent Harness 2.0 Shipped overlay: I1 verify-before-done on /sdlc-spdd-code, I2 review check-operation-diff-scope, I3 copy-only pre-commit.sample. Not a new Python agent runtime
Uberorchbot via SDLC-SPDD Vision: Cloud Agents + Environments; this orchestrator commits .cursor/environment.json (U2). Uberorchbot dispatches; SDLC-SPDD governs
Blog: Cloud Agents as the SDLC platform Publishable draft of the intended four-layer architecture
Research notes index Academic program (SPIKE-004) vs product/integration research
SDLC Engine — commit-message Python engine diff report for /sdlc-spdd-commit-message
SDLC Engine — sunset Close-out snapshot of GitHub PR, GitHub issue, commits, and Jira into the ledger
Guide flow End-to-end Guide working store: ledger + canvas ingest, runtime resolution, per-phase tools, persist loop
DICE projection runbook Run against Guide tag spdd-projection-v3 (or GUIDE_GIT_REF=main): typed entity persist/retrieve, spdd_* MCP tools
Narrated demos bundle You maintain or extend the docgen bundle under docs/demos/
TESTING.md You need the command-testing confidence stack (CI gates, local smoke, planning-sync verification)
Design decisions Rationale for major choices (including planned-but-not-installed features)

Prompt Standards by Concept

Start with Session prompt standard — it is the default for day-to-day agent work. That page includes Which prompt standard? — a decision guide for when to drill into SPDD or Planning.

Guide Use it when
Session prompt standard Default. Starting, continuing, or ending an agent session across all layers
SPDD prompt standard Canvas governance only: alignment, architect, operations scope, review, prompt-update, sync
Planning prompt standard Delivery narrative only: roadmap, milestones, session notes, capture, roadmap refresh

If You Need Stack or Reference Material

Guide Use it when
Java Spring Boot usage You are applying SDLC-SPDD to a Spring Boot project
Tekton usage You are applying SDLC-SPDD to Tekton pipelines
Roadmap Planned capabilities (repo root, not docs/)

Quick Start (one path)

Follow the adoption path in the repository README: install → first day → three-part operating path → daily prompts.

After install, target-local copies of these docs live at docs/sdlc-spdd/ in your application. Cursor/Copilot/Claude Code slash-command examples: Initialization and invocation.