Skip to content

Commit 3a4c369

Browse files
authored
Add diagram showing generated prompt structure to README (#188)
1 parent 31a8a06 commit 3a4c369

1 file changed

Lines changed: 47 additions & 0 deletions

File tree

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,53 @@ This tool collects context from predefined rule files and a task-specific prompt
88
**📋 [View Specification](./SPECIFICATION.md)** - The Coding Context Standard
99
**📊 [View Slide Deck](./SLIDES.md)** | [Download PDF](./SLIDES.pdf) | [How to Present](./SLIDES_README.md)
1010

11+
## Generated Context Structure
12+
13+
The tool assembles context into a structured prompt with the following components:
14+
15+
```
16+
┌─────────────────────────────────────────────────────────────┐
17+
│ Generated Coding Context Prompt │
18+
├─────────────────────────────────────────────────────────────┤
19+
│ │
20+
│ ┌───────────────────────────────────────────────────────┐ │
21+
│ │ 1. Task Frontmatter (YAML) │ │
22+
│ │ • Task metadata (selectors, agent, etc.) │ │
23+
│ │ • Always included when task has frontmatter │ │
24+
│ └───────────────────────────────────────────────────────┘ │
25+
│ │
26+
│ ┌───────────────────────────────────────────────────────┐ │
27+
│ │ 2. Skills Metadata (XML) - Optional │ │
28+
│ │ • Available skills with names & descriptions │ │
29+
│ │ • Progressive disclosure - full content on demand │ │
30+
│ │ • Only included if skills are discovered │ │
31+
│ └───────────────────────────────────────────────────────┘ │
32+
│ │
33+
│ ┌───────────────────────────────────────────────────────┐ │
34+
│ │ 3. Rules Content (Markdown) │ │
35+
│ │ • Coding standards and guidelines │ │
36+
│ │ • Team conventions and best practices │ │
37+
│ │ • Filtered by selectors (-s flag) │ │
38+
│ │ • Skipped in resume mode (-r flag) │ │
39+
│ └───────────────────────────────────────────────────────┘ │
40+
│ │
41+
│ ┌───────────────────────────────────────────────────────┐ │
42+
│ │ 4. Task Content (Markdown) │ │
43+
│ │ • Task-specific instructions │ │
44+
│ │ • Parameter substitutions (${param}) │ │
45+
│ │ • Command expansions (!`command`) │ │
46+
│ │ • Path expansions (@file) │ │
47+
│ └───────────────────────────────────────────────────────┘ │
48+
│ │
49+
└─────────────────────────────────────────────────────────────┘
50+
```
51+
52+
**Key Points:**
53+
- **Task Frontmatter**: Provides metadata for agent decision-making and workflow automation
54+
- **Skills**: Enable progressive disclosure of specialized capabilities
55+
- **Rules**: Reusable context that applies across multiple tasks
56+
- **Task Content**: Specific instructions for the current task with dynamic content expansion
57+
1158
## Features
1259

1360
- **Dynamic Context Assembly**: Merges context from various source files.

0 commit comments

Comments
 (0)