Skip to content

docs: fix README headline — spec-driven framing, plain language#112

Open
PatrickSys wants to merge 1 commit into
mainfrom
docs-agentic-sdd-public-docs
Open

docs: fix README headline — spec-driven framing, plain language#112
PatrickSys wants to merge 1 commit into
mainfrom
docs-agentic-sdd-public-docs

Conversation

@PatrickSys
Copy link
Copy Markdown
Owner

Summary

  • Replaces abstract tagline with spec-driven framing: "Spec-driven development for AI-assisted work. The spec, plan, and verification live as markdown files in your repo — so every session starts from the same ground truth instead of a blank chat window."
  • Removes "repo-native delivery spine" and similar buzzword framing
  • Rewrites comparison table Workspine row in plain language
  • Tightens "Where it fits" prose to be concrete and direct

What changed and why

The previous README still led with corporate-sounding language ("delivery spine", "any agent or runtime") that obscured what the tool actually is: markdown files in the repo that give AI agents a consistent spec to follow across sessions. This rewrite leads with that honestly.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the README to reframe the project around spec-driven development and persistent markdown files. The feedback identifies an inconsistency in the package.json description that should be addressed to match this new framing and provides a grammatical correction for the updated README text.

Comment thread README.md
# Workspine

AI agents forget when the session ends. Workspine writes plans, decisions, and verification to `.planning/` so any agent or runtime can pick up where the last one stopped.
Spec-driven development for AI-assisted work. The spec, plan, and verification live as markdown files in your repo — so every session starts from the same ground truth instead of a blank chat window.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The PR summary mentions removing the "repo-native delivery spine" framing, but this terminology (and the "repo-native" buzzword) still persists in the package.json description. To ensure consistency with the new spec-driven framing, please update the description field in package.json as well.

Comment thread README.md
## Where it fits

Use Workspine when a feature takes more than one session, or when you need to switch between Claude, Codex, and Cursor without losing the thread. Skip it for quick, obvious edits — direct prompting is cheaper when the risk is small.
Use Workspine when a feature takes more than one session, or when you keep switching between Claude, Codex, and Cursor and losing the thread. Skip it for quick obvious edits — just prompting is faster.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The phrasing "and Cursor and losing the thread" is slightly clunky due to the repeated conjunction. Additionally, "quick obvious" should be separated by a comma as they are coordinate adjectives modifying "edits".

Suggested change
Use Workspine when a feature takes more than one session, or when you keep switching between Claude, Codex, and Cursor and losing the thread. Skip it for quick obvious edits — just prompting is faster.
Use Workspine when a feature takes more than one session, or when switching between Claude, Codex, and Cursor causes you to lose the thread. Skip it for quick, obvious edits — just prompting is faster.

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