Skip to content

Commit f5b0e8e

Browse files
Austin LovelessAustin Loveless
authored andcommitted
chore: updated docs to have more initial detail
1 parent 9ead128 commit f5b0e8e

File tree

1 file changed

+41
-6
lines changed

1 file changed

+41
-6
lines changed

README.md

Lines changed: 41 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,15 @@
1616

1717
## TLDR / Quickstart
1818

19-
**Want to install these prompts as slash commands?** Use the [slash-command-manager](https://github.com/liatrio-labs/slash-command-manager) utility to install them in all of your local AI tools:
19+
### What is this?
20+
21+
This repository provides **structured prompts** (Markdown files) that guide AI assistants through a complete software development workflow: from initial feature idea → detailed specification → task breakdown → implementation → validation. Think of them as reusable playbooks that keep AI agents focused and consistent.
22+
23+
### Installation Options
24+
25+
#### Option A: Install as Slash Commands (Recommended)
26+
27+
Install these prompts as native `/slash-commands` in your AI assistant (Cursor, Windsurf, Claude Code, etc.) using the [slash-command-manager](https://github.com/liatrio-labs/slash-command-manager) utility:
2028

2129
```bash
2230
uvx --from git+https://github.com/liatrio-labs/slash-command-manager \
@@ -26,15 +34,42 @@ uvx --from git+https://github.com/liatrio-labs/slash-command-manager \
2634
--github-path prompts/
2735
```
2836

29-
**Want to use the prompts directly?** Copy-paste them into your AI assistant:
37+
**What this command does:**
38+
- `uvx` runs Python tools without installation (like `npx` for Python)
39+
- Fetches the `slash-command-manager` tool from GitHub
40+
- `slash-man generate` auto-detects your installed AI assistants
41+
- Downloads the prompt files from `prompts/` directory
42+
- Installs them as slash commands like `/generate-spec`, `/manage-tasks`, etc.
43+
44+
**Result:** You can now type `/generate-spec` in your AI assistant to start the workflow.
45+
46+
#### Option B: Manual Copy-Paste (No Installation)
47+
48+
Copy the prompt files directly from `prompts/` and paste them into your AI chat. The AI will follow the structured instructions in each prompt.
49+
50+
### The 4-Step Workflow
51+
52+
Each step uses a different prompt file and produces specific artifacts:
3053

31-
1. **Generate a spec:** Copy `prompts/generate-spec.md` into your AI chat → AI assesses scope, asks structured questions (numbered/lettered options), optionally reviews codebase, generates spec, iterates with you → Spec saved to `docs/specs/01-spec-<feature-name>/01-spec-<feature-name>.md`
54+
1. **Generate a Spec** (`prompts/generate-spec.md`)
55+
- **What it does:** Guides AI to ask clarifying questions, assess scope, and create a detailed specification document
56+
- **Output:** `docs/specs/01-spec-<feature-name>/01-spec-<feature-name>.md` — A comprehensive spec with goals, requirements, demo criteria, and success metrics
57+
- **Why:** Ensures everyone (human and AI) agrees on what to build before writing code
3258

33-
2. **Generate task list:** Point AI to spec (or let it auto-discover) and use `prompts/generate-task-list-from-spec.md` → AI analyzes spec, generates parent tasks for review, then after confirmation expands into sub-tasks with "Relevant Files" section → Saved to `docs/specs/01-spec-<feature-name>/01-tasks-<feature-name>.md`
59+
2. **Generate Task List** (`prompts/generate-task-list-from-spec.md`)
60+
- **What it does:** Breaks the spec into parent tasks (demoable units) and detailed sub-tasks with relevant files
61+
- **Output:** `docs/specs/01-spec-<feature-name>/01-tasks-<feature-name>.md` — A checklist of all work items with `[ ]` not started, `[~]` in progress, `[x]` complete
62+
- **Why:** Creates an actionable implementation plan with clear checkpoints
3463

35-
3. **Manage tasks:** Use `prompts/manage-tasks.md` while implementing → Choose checkpoint mode (Continuous/Task/Batch), execute with verification checklists, create proof artifacts **before** commits → Proofs saved to `docs/specs/01-spec-<feature-name>/01-proofs/[NN]-task-[TT]-proofs.md`
64+
3. **Manage Tasks** (`prompts/manage-tasks.md`)
65+
- **What it does:** Guides execution with verification checklists, creates proof artifacts (screenshots, test results, CLI output) before each commit
66+
- **Output:** `docs/specs/01-spec-<feature-name>/01-proofs/[NN]-task-[TT]-proofs.md` — Evidence that each task works as intended
67+
- **Why:** Maintains quality and creates a verifiable audit trail of what was built
3668

37-
4. **Validate:** Use `prompts/validate-spec-implementation.md` (or let it auto-discover) → AI verifies proof artifacts, applies validation gates, produces coverage matrix and validation report
69+
4. **Validate Implementation** (`prompts/validate-spec-implementation.md`)
70+
- **What it does:** Verifies the implementation matches the spec using proof artifacts, applies validation gates, generates coverage matrix
71+
- **Output:** Validation report showing what's verified, what's missing, and any issues
72+
- **Why:** Confirms the feature is complete and meets all requirements before shipping
3873

3974
5. **SHIP IT** 🚢💨
4075

0 commit comments

Comments
 (0)