Skip to content

ADR-393: Add template reference, revise mode, and concision pass to dev-spec pipeline - #244

Draft
jodavis-claude wants to merge 2 commits into
feature/ADR-336-proposal-detailed-design-splitfrom
dev/claude/ADR-393
Draft

ADR-393: Add template reference, revise mode, and concision pass to dev-spec pipeline#244
jodavis-claude wants to merge 2 commits into
feature/ADR-336-proposal-detailed-design-splitfrom
dev/claude/ADR-393

Conversation

@jodavis-claude

Copy link
Copy Markdown
Collaborator

Work item: ADR-393 — bring dev-spec-first-draft/write-dev-spec in line with the same three small features added elsewhere in epic ADR-336 to proposal-first-draft/write-proposal and detailed-design-first-draft/write-detailed-design: an external template reference, a "Revising an existing document" re-entrancy step, and a final document-concision-pass tightening pass.

Changes:

  • plugins/dev-team/commands/write-dev-spec.md — inserted a new step 2 ("Check for an existing dev spec") that substitutes the resolved work-item-id into documentation.dev-specs.search and, if found, records its path for revise mode; renumbered remaining steps; step 3 ("Write the first draft") now invokes dev-spec-first-draft in revise mode when an existing spec was found; added a new final step 9 ("Final concision pass") invoking document-concision-pass on the finished spec file, after dev-spec-task-work-items.
  • plugins/dev-team/skills/dev-spec-first-draft/SKILL.md — inserted a new step 2 ("Revising an existing document"), mirroring proposal-first-draft/detailed-design-first-draft's equivalent step but adapted to this skill's existing batched-AskUserQuestion interaction style; renumbered old steps 2–3 to 3–4. The drafting step now skips location-determination when revising, writes/updates the file, tightens TBD/Open-Questions wording to require explicit user confirmation before anything is left open, adds a ## Contents regeneration note (write/regenerate last), and ends with a document-concision-pass invocation.
  • plugins/dev-team/skills/dev-spec-first-draft/assets/dev_spec_template.md (new) — the pre-authored template dev-spec-first-draft/SKILL.md already linked to but was missing from this branch; brought over verbatim from the still-open spec-authoring PR (ADR-336: Dev spec + proposal/detailed-design/dev-spec templates #170).
  • plugins/dev-team/skills/document-concision-pass/SKILL.md (new) — the skill both files above call; brought over verbatim from the still-open ADR-390 PR (ADR-390: Author document-concision-pass skill #239), this task's stated dependency.

Design decisions:

  • Brought in only the two specific dependency files this task's changes reference (document-concision-pass/SKILL.md and dev_spec_template.md), rather than merging/rebasing in unrelated history from PR ADR-336: Dev spec + proposal/detailed-design/dev-spec templates #170 or PR ADR-390: Author document-concision-pass skill #239, keeping the diff scoped to exactly what ADR-393 needs.
  • Implemented the ## Contents regeneration note despite no matching exit-criteria checkbox, for consistency with proposal-first-draft/detailed-design-first-draft and because the spec's "Table of Contents on every spec document" decision requires it.
  • Confirmed dev-spec-first-draft/SKILL.md already externally referenced assets/dev_spec_template.md (exit criterion already met; only the file itself was missing) and tightened the existing TBD wording further to explicitly require user confirmation before anything is left open.
  • No unit or E2E tests: both components are Wrapper-tier prompt/instruction content with no automated test harness in this repo, consistent with this epic's other sibling tasks (ADR-387/388/389/390).

Testing completed:

  • Performed a best-effort mechanical dry run of the re-entrancy check's config-substitution logic (verified documentation.dev-specs.search, substituted with an existing spec's work-item-id, correctly matches that spec file) in place of the full live/interactive /write-dev-spec validation, which requires user interaction outside a non-interactive Developer task's reach. The full live dry run remains outstanding for human/pipeline validation follow-up.

Known follow-ups:

…spec
Inserts a new step 2 that checks documentation.dev-specs.search for an existing dev spec and, if found, has step 3 invoke dev-spec-first-draft in revise mode instead of first-draft mode. Adds a final step 9 that runs document-concision-pass over the finished spec, for symmetry with write-proposal/write-detailed-design. Also brings in document-concision-pass/SKILL.md (authored on ADR-390's still-open branch) so this reference resolves to a real skill, per ADR-393's stated dependency on ADR-390.
… and final concision pass to dev-spec-first-draft
Inserts a new step 2 'Revising an existing document', mirroring proposal-first-draft/detailed-design-first-draft but adapted to this skill's existing batched-AskUserQuestion interaction style rather than a section-by-section interview rewrite. Step 3 (renumbered from step 2) now writes/regenerates the Contents section last, tightens the TBD/Open Questions language to require explicit user confirmation rather than a silent default, and ends with a document-concision-pass call. Also brings in the pre-authored assets/dev_spec_template.md (already linked by this file, but missing from this branch) from the still-open ADR-336 spec-authoring PR.
@github-actions

Copy link
Copy Markdown

build-and-test: Python test results

Status: ✅ Passed

Test log

@jodavis-claudejodavis-claude left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the ADR-393 diff (plugins/dev-team/commands/write-dev-spec.md,
plugins/dev-team/skills/dev-spec-first-draft/SKILL.md, the new
assets/dev_spec_template.md, and the new document-concision-pass/SKILL.md) against the task
brief's exit criteria, CONTRIBUTING.md, and this epic's established sibling precedent
(origin/dev/claude/ADR-387's proposal-first-draft/SKILL.md).

What was checked:

  • dev-spec-first-draft/SKILL.md step 3 already referenced (and continues to reference)
    assets/dev_spec_template.md externally; the missing template file itself is now added,
    brought over verbatim as instructed.
  • New step 2 ("Revising an existing document") sits between "Gather context" and "Write the
    first draft," with wording closely mirroring proposal-first-draft's equivalent step, adapted
    correctly for this skill's batched-AskUserQuestion style rather than a section-by-section
    interview rewrite.
  • TBD/Open-Questions wording now explicitly requires user confirmation before anything stays
    open ("Confirm with the user before leaving anything open") — no silent default.
  • The drafting step ends with a ## Contents-last regeneration note followed by a
    document-concision-pass invocation, matching the precedent skill's ordering exactly.
  • write-dev-spec.md's new step 2 ("Check for an existing dev spec") precedes step 3 ("Write the
    first draft"), correctly gating revise-mode invocation.
  • write-dev-spec.md's new step 9 ("Final concision pass") is the last step, after step 8
    (dev-spec-task-work-items).
  • Step renumbering is internally consistent in both modified files; grepped the rest of the repo
    for other files referencing dev-spec-first-draft/write-dev-spec by step number — none found,
    so no stale cross-reference was introduced.
  • New files end with a single trailing newline, consistent with .editorconfig.
  • document-concision-pass/SKILL.md's frontmatter shape matches sibling document-* skills
    (document-discussion, document-readiness-review).
  • CI (build-and-test, gate) is green on this PR.
  • The final "Validate" exit-criteria checkbox is correctly left unresolved/unchecked, since it
    requires a live interactive /write-dev-spec run outside a non-interactive session's reach — a
    best-effort mechanical dry run was substituted and the gap is explained rather than faked. This
    matches the exact precedent already established and approved on this epic's ADR-387 PR (#171).

This is a documentation/prompt-only (Wrapper-tier) change with no runtime code, so most of the
standard priority list (fault tolerance, security, performance) doesn't apply. No Priority 1-4
issues found.

@jodavis-claudejodavis-claude left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sign-off review — ADR-393

No unresolved review threads exist on this PR (the first-pass review found zero Priority 1–4 issues and left no threads open).

No commits have landed since that review pass, so the diff is unchanged from what was already reviewed and approved:

  • plugins/dev-team/commands/write-dev-spec.md
  • plugins/dev-team/skills/dev-spec-first-draft/SKILL.md
  • plugins/dev-team/skills/dev-spec-first-draft/assets/dev_spec_template.md
  • plugins/dev-team/skills/document-concision-pass/SKILL.md

Re-scanned all four files against CONTRIBUTING.md and this epic's proposal-first-draft precedent — no new issues found. Step renumbering in both modified files is internally consistent, the new revise-mode/re-entrancy/concision-pass steps sit in the ordering the task brief specifies, and CI is green.

Signing off: approved.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@jodavis-claude@ElwoodMoves