Skip to content

docs: resolve assess clarifications by editing artifacts in place - #4402

Open
gyanu2507 wants to merge 1 commit into
github:mainfrom
gyanu2507:docs/4378-assess-in-place-clarification
Open

docs: resolve assess clarifications by editing artifacts in place#4402
gyanu2507 wants to merge 1 commit into
github:mainfrom
gyanu2507:docs/4378-assess-in-place-clarification

Conversation

@gyanu2507

Copy link
Copy Markdown

Summary

  • Document that assess stages normally run once and leave editable Markdown
  • Point needs-clarification at refining the named artifact (or decision.md), not re-running the stage by default
  • Update the assess README flow diagram and speckit.assess.decide guidance to match

Context

[NEEDS CLARIFICATION: …] markers were easy to read as “go back and re-run intake/research/…”. The assess extension is meant to be sequential: fill gaps in the existing files, then continue. A dedicated clarify loop stays out of scope (custom extension/preset territory).

Test plan

  • uv run pytest tests/extensions/assess/
  • Quick read of extensions/assess/README.md and speckit.assess.decide.md for consistency

Fixes #4378

Made with Cursor

The assess README and decide command told people to re-run an earlier
stage when decision.md said needs-clarification. That fights the
sequential intake → research → define → shape → decide flow: each
command normally runs once and leaves an editable Markdown file.

Document direct edits and free-form agent updates as the default path,
including refining decision.md itself, and keep stage re-runs as the
exception for bad or discarded drafts.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

Two moderate documentation inconsistencies must be resolved before approval.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Documents in-place clarification for the sequential assess workflow rather than rerunning stages.

Changes:

  • Explains editable artifact refinement.
  • Updates decision-stage clarification guidance.
  • Revises the assess flow diagram.
File summaries
File Review
extensions/assess/README.md Flow diagram still routes clarification back to intake; use an artifact-refinement node returning to the decision.
extensions/assess/commands/speckit.assess.decide.md Add decision.md to the allowed clarification artifacts.
Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 2
  • Review effort level: Balanced

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

C -->|go| SPEC[/speckit.specify/]
C -->|kill| X[closed, recorded]
C -.->|needs-clarification: revisit the named earlier stage| A
C -.->|needs-clarification: refine the named artifact in place| A

- **Blocking questions**: [NEEDS CLARIFICATION: …]
- **Revisit stage**: intake | research | define | shape
- **Artifact to refine**: intake.md | research.md | problem.md | concept.md
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.

[Feature]: Document in-place clarification of assessment artifacts

3 participants