Skip to content

refactor(quick-dev): rename tech-spec prefix to spec#2109

Merged
alexeyv merged 2 commits intomainfrom
refactor/rename-spec-prefix
Mar 23, 2026
Merged

refactor(quick-dev): rename tech-spec prefix to spec#2109
alexeyv merged 2 commits intomainfrom
refactor/rename-spec-prefix

Conversation

@alexeyv
Copy link
Copy Markdown
Collaborator

@alexeyv alexeyv commented Mar 23, 2026

Summary

  • Rename tech-spec-template.mdspec-template.md and update all filename-generating references (tech-spec-wipspec-wip, tech-spec-{slug}spec-{slug})
  • Tighten correct-course glob from *tech-spec* to *spec-* to match both old and new naming without catching ux-design-specification.md
  • Update all docs (EN/FR/ZH-CN) and module-help.csv to reflect the rename
  • Replace stale "quick flow" label with "intent-in code-out workflow"

Test plan

  • Run quick-dev plan-code-review path — verify spec creates as spec-{slug}.md
  • Run quick-dev — verify WIP creates as spec-wip.md
  • Verify *spec-* glob matches both tech-spec-foo.md and spec-bar.md
  • Verify *spec-* glob does NOT match ux-design-specification.md
  • npm run quality passes

🤖 Generated with Claude Code

@alexeyv alexeyv force-pushed the refactor/rename-spec-prefix branch from 450b2d9 to 110d24e Compare March 23, 2026 06:03
@augmentcode
Copy link
Copy Markdown

augmentcode bot commented Mar 23, 2026

🤖 Augment PR Summary

Summary: This PR renames the Quick Dev “tech-spec” artifact prefix to “spec” and propagates the change across workflows and documentation.

Changes:

  • Renamed the Quick Dev template file to spec-template.md and updated Quick Dev steps to generate spec-wip.md / spec-* artifacts
  • Updated Correct Course document discovery to look for spec artifacts using a tighter *spec-* glob
  • Refreshed workflow maps and getting-started docs (EN/FR/ZH-CN) to reflect the new naming
  • Updated wording in explanatory docs to use “spec” terminology consistently

Technical Notes: The new glob is intended to match both tech-spec-.md and spec-.md without matching “specification” files like ux-design-specification.md.

🤖 Was this summary useful? React with 👍 or 👎

Copy link
Copy Markdown

@augmentcode augmentcode bot left a comment

Choose a reason for hiding this comment

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

Review completed. 3 suggestions posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.

| Architecture | `{planning_artifacts}/*architecture*.md` (whole) or `{planning_artifacts}/*architecture*/*.md` (sharded) | FULL_LOAD |
| UX Design | `{planning_artifacts}/*ux*.md` (whole) or `{planning_artifacts}/*ux*/*.md` (sharded) | FULL_LOAD |
| Tech Spec | `{planning_artifacts}/*tech-spec*.md` (whole) | FULL_LOAD |
| Spec | `{planning_artifacts}/*spec-*.md` (whole) | FULL_LOAD |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The {planning_artifacts}/*spec-*.md pattern won’t match legacy whole-doc names like tech-spec.md/spec.md (no trailing -), so Correct Course may silently miss the spec in some projects. (Guideline: skill_validation)

Severity: medium

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 23, 2026

📝 Walkthrough

Walkthrough

The PR systematically updates documentation and workflow configuration files to replace "tech-spec" terminology with "spec" across English, French, and Chinese documentation, and adjusts corresponding file naming conventions and path patterns in workflow implementation files.

Changes

Cohort / File(s) Summary
English Documentation
docs/_STYLE_GUIDE.md, docs/explanation/established-projects-faq.md, docs/explanation/project-context.md, docs/reference/workflow-map.md, docs/tutorials/getting-started.md
Replaced "tech-spec" with "spec" in planning phase descriptions, quick flow references, workflow output documentation, and FAQ content.
Localized Documentation
docs/fr/reference/workflow-map.md, docs/fr/tutorials/getting-started.md, docs/zh-cn/_STYLE_GUIDE.md, docs/zh-cn/explanation/established-projects-faq.md, docs/zh-cn/reference/workflow-map.md
Updated French and Chinese documentation to replace "tech-spec" with "spec" in workflow mappings, tutorial references, and terminology sections.
Workflow Implementation Files
src/bmm-skills/4-implementation/bmad-correct-course/workflow.md, src/bmm-skills/4-implementation/bmad-quick-dev/step-01-clarify-and-route.md, src/bmm-skills/4-implementation/bmad-quick-dev/step-02-plan.md, src/bmm-skills/4-implementation/bmad-quick-dev/workflow.md
Updated WIP artifact paths from tech-spec-wip.md to spec-wip.md, discovery glob patterns from \*tech-spec\*.md to \*spec-\*.md, and template references from tech-spec-template.md to spec-template.md.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • bmadcode
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'refactor(quick-dev): rename tech-spec prefix to spec' directly and clearly summarizes the main objective of the changeset—renaming the tech-spec prefix to spec across the quick-dev workflow and related documentation.
Description check ✅ Passed The description is directly related to the changeset, providing a clear summary of the rename operations, glob pattern updates, documentation changes, and test plan that align with the actual file changes shown in the raw summary.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

Important

Merge conflicts detected (Beta)

  • Resolve merge conflict in branch refactor/rename-spec-prefix
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch refactor/rename-spec-prefix

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/tutorials/getting-started.md (1)

72-83: ⚠️ Potential issue | 🟡 Minor

Complete the terminology rename in the planning-track table

This section now uses spec (Line 72), but the Quick Flow row still says “Tech-spec only”. Please rename it to keep terminology consistent.

Suggested doc fix
-| **Quick Flow**  | Bug fixes, simple features, clear scope (1-15 stories) | Tech-spec only                         |
+| **Quick Flow**  | Bug fixes, simple features, clear scope (1-15 stories) | Spec only                              |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/tutorials/getting-started.md` around lines 72 - 83, The planning-track
table in docs/tutorials/getting-started.md is inconsistent: change the "Quick
Flow" table cell that currently reads "Tech-spec only" to match the rest of the
doc and use "spec only" (or "Spec only" per local capitalization) so the Quick
Flow row aligns with the earlier use of "spec"; update the "Quick Flow" row in
the planning-track table accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/fr/reference/workflow-map.md`:
- Line 71: Update the workflow-map entry for the `bmad-quick-dev` workflow to
reflect the actual generated filename pattern: change the documented `spec.md`
output to `spec-{slug}.md` (and keep the "+ code" note intact) so the table
accurately shows the produced files.

---

Outside diff comments:
In `@docs/tutorials/getting-started.md`:
- Around line 72-83: The planning-track table in
docs/tutorials/getting-started.md is inconsistent: change the "Quick Flow" table
cell that currently reads "Tech-spec only" to match the rest of the doc and use
"spec only" (or "Spec only" per local capitalization) so the Quick Flow row
aligns with the earlier use of "spec"; update the "Quick Flow" row in the
planning-track table accordingly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: a6cccabc-3675-408a-be41-51f7968ae4c2

📥 Commits

Reviewing files that changed from the base of the PR and between fc2b253 and 450b2d9.

⛔ Files ignored due to path filters (1)
  • src/bmm-skills/module-help.csv is excluded by !**/*.csv
📒 Files selected for processing (15)
  • docs/_STYLE_GUIDE.md
  • docs/explanation/established-projects-faq.md
  • docs/explanation/project-context.md
  • docs/fr/reference/workflow-map.md
  • docs/fr/tutorials/getting-started.md
  • docs/reference/workflow-map.md
  • docs/tutorials/getting-started.md
  • docs/zh-cn/_STYLE_GUIDE.md
  • docs/zh-cn/explanation/established-projects-faq.md
  • docs/zh-cn/reference/workflow-map.md
  • src/bmm-skills/4-implementation/bmad-correct-course/workflow.md
  • src/bmm-skills/4-implementation/bmad-quick-dev/spec-template.md
  • src/bmm-skills/4-implementation/bmad-quick-dev/step-01-clarify-and-route.md
  • src/bmm-skills/4-implementation/bmad-quick-dev/step-02-plan.md
  • src/bmm-skills/4-implementation/bmad-quick-dev/workflow.md

@alexeyv alexeyv force-pushed the refactor/rename-spec-prefix branch from 110d24e to fd72706 Compare March 23, 2026 06:06
@alexeyv alexeyv merged commit b3cf338 into main Mar 23, 2026
5 checks passed
@alexeyv alexeyv deleted the refactor/rename-spec-prefix branch March 23, 2026 06:09
Sign up for free to 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.

1 participant