Skip to content

Guide#18

Open
cpplain wants to merge 18 commits intomainfrom
guide
Open

Guide#18
cpplain wants to merge 18 commits intomainfrom
guide

Conversation

@cpplain
Copy link
Copy Markdown
Owner

@cpplain cpplain commented Mar 28, 2026

No description provided.

cpplain added 18 commits March 27, 2026 19:30
Add docs/guide/ section for practical usage guidance, separate from
design specs. Includes an incremental spec-driven development workflow
guide and placeholder files for design specs, prompts, and configuration
guides.
Covers the spec-writing process (6-step engineer-agent collaboration)
and a quality reference checklist for agent consumption, testability,
decision rationale, and spec organization.
Replace the step-by-step spec-writing process with a properties-based
reference. The guide now defines what a good spec looks like through
nine properties with concrete examples and a readiness checklist,
rather than prescribing how to produce one. The engineer-agent pair
determines their own path to a spec that meets the criteria.
Add cross-boundary contract heuristic, glossary location pointer,
and expand readiness checklist to cover all properties.
…ecs guide

Add concrete examples for the two gaps that would cause inconsistent
agent output: cross-boundary contract identification (with a borderline
case teaching stabilization intent) and testable side-effect
specification (file creation with permissions, atomicity, error cases).
Redundant explanatory prose in the properties section restated what
property names and checklist items already convey, creating a document
that invited endless iteration without convergence. Cut teaching prose,
kept load-bearing material (cross-boundary examples, vague/precise
pairs, diagnostic instructions), and removed the "Concrete examples"
property entirely as redundant with the template and checklist.
Combine the planned prompts and configuration guides into a single
configuration guide covering the full .lorah directory setup: plan
file, prompt file, settings, and CLI flags.
Replace project-specific linting commands and comment flagging with a
single directive to surface non-obvious discoveries via CLAUDE.md.
Split configuration guide into focused pages: prompts.md for router
and phase prompt templates, tasks.md for task file format. Add plan
file template to configuration.md. Align "scope document" terminology
in workflow.md to "plan file" for consistency across guides.
Remove role-playing framing from router template. Add routing for
blocked tasks to plan phase, where they are revised before new work
is selected. Add design spec reading to implement phase workflow for
consistency with its blocked workflow.
- Fix workflow.md to use task file (not plan file) for blocked issues
- Add blocked task recovery to Phase 2 description
- Remove unused `pending` status from tasks.md
- Add attribution field explanation to configuration.md
- Note that .lorah/ should be committed to git
- Add cross-reference from design-specs.md to workflow.md
- Distinguish --dir as a Lorah flag, not a Claude CLI flag
- Introduce the lorah CLI before its first usage in examples
- Break dense opening paragraph in design-specs into three
- Generalize glossary location reference
- Add blocked task handling section to tasks.md
- Make single-active-task invariant explicit in router prompt
- Specify glossary belongs in a shared file or specs README
- State single-active-task invariant in tasks.md
- Add constraints to plan file description in workflow.md
Add completion check to plan prompt template so the agent exits
when all acceptance criteria are met. Fix "scope document" to
"plan file", add task files to continuity claim, and clarify
task log section reference.
Sequential "Phase 1-4" numbering implied linear execution, but only
scoping runs once — the other three steps repeat. Renamed to "Setup"
and "Loop step 1-3" so headings self-document the flow. Folded the
standalone Loop section's termination condition into Loop step 1.
Include a complete .lorah scaffold with settings, main prompt,
task template, and phase-specific workflow prompts (plan, test,
implement).
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