SDLC blueprint

Handbook

Initializing the project `sdlc/` workspace

This blueprint ships **canonical copies** of the engineering-tracking Markdown files and a **`README` template** under [`templates/sdlc/`](templates/sdlc). Use them to create a **mutable** `sdlc/` fol

Initializing the project sdlc/ workspace

This blueprint ships canonical copies of the engineering-tracking Markdown files and a README template under templates/sdlc/. Use them to create a mutable sdlc/ folder at the repository root (next to blueprints/sdlc/), without copying project-specific prose from another repo by hand.

What gets created

Path (repo root) Source
sdlc/README.md From SDLC — {{PROJECT_NAME}} with {{PROJECT_NAME}} replaced
sdlc/TRACKING-FOUNDATION.md Copy of Tracking foundation (single spine)
sdlc/TRACKING-METHODOLOGIES.md Copy of Methodologies (lenses on the tracking foundation)
sdlc/TRACKING-CHALLENGES.md Copy of Tracking challenges (separate from the foundation)

Prerequisites

  • Repository root contains blueprints/sdlc/ (this package).
  • You plan to add docs/ (or equivalent) per Documentation structure — proposal; paths in README.md assume the usual layout.

Option A — script (recommended)

From the repository root. Full flags and prerequisites: scripts/README.md.

./blueprints/sdlc/scripts/init-sdlc-workspace.sh "My Product Name"

Optional second argument: target directory (default sdlc):

./blueprints/sdlc/scripts/init-sdlc-workspace.sh "My Product Name" sdlc

If README.md already exists in the target, the script refuses to overwrite unless you pass --force (overwrites only README.md; tracking files are always copied).

Option B — manual

  1. mkdir -p sdlc
  2. Copy the three TRACKING-*.md files from blueprints/sdlc/templates/sdlc/ into sdlc/.
  3. sed 's/{{PROJECT_NAME}}/Your Project/g' blueprints/sdlc/templates/sdlc/README.template.md > sdlc/README.md (or edit by hand).
  4. Link sdlc/README.md from the root README.md and Documentation structure — proposal as you adopt docs/.

After init

  • Customize sdlc/README.md: remove table rows for paths you do not use yet (e.g. blueprints/product/, docs/product/) if the repo is slimmer than the template.
  • Link the handbook: docs/index.html already references ../../../sdlc/TRACKING-*.md when those files exist.
  • Do not edit the frozen blueprint for project-only notes; keep them in sdlc/ or docs/.

Drift

When tracking content in the living sdlc/ folder is improved, consider backporting the generic parts into blueprints/sdlc/templates/sdlc/ so the next project gets the same baseline.

Compare with an existing sdlc/

After generating a scratch folder (e.g. sdlc.new/), see `sdlc/` vs `sdlc.new/` (generated) — comparison notes for what should match and what differs in README.md only.

Canonical source

Edit https://github.com/autowww/blueprints/blob/main/sdlc/SDLc-WORKSPACE.md first; regenerate with docs/build-handbook.py.