Skip to content

Commit db6b656

Browse files
committed
Add README for GitHub visitors
1 parent 3f9d225 commit db6b656

File tree

1 file changed

+109
-0
lines changed

1 file changed

+109
-0
lines changed

README.md

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
# PRISM v3.4
2+
3+
**Progressive Retrieval-Optimised Information Structure Maker**
4+
5+
A methodology for transforming monolithic system prompts into Claude Projects-optimised knowledge architectures.
6+
7+
## The Problem
8+
9+
Large system prompts hit Claude's context limits and degrade retrieval accuracy. Claude Projects solves this with knowledge files, but poorly structured files lead to retrieval failures—Claude fetches the wrong content or misses relevant information entirely.
10+
11+
## The Solution
12+
13+
PRISM transforms sprawling prompts into retrieval-optimised knowledge systems using a three-layer architecture:
14+
15+
| Layer | Purpose | Size Target |
16+
|-------|---------|-------------|
17+
| **Instructions** | Routes queries to content (conductor pattern) | 4,000-8,000 chars |
18+
| **Operational** | HOW the system works (workflows, decisions) | 2,000-5,000 chars/file |
19+
| **Reference** | WHAT the system knows (concepts, examples) | 2,000-6,000 chars/file |
20+
21+
> **Core Insight:** Instructions should be a CONDUCTOR, not a CONTAINER. They route to content; they don't hold it. If Instructions exceed 8,000 chars, you're putting sheet music in the conductor.
22+
23+
## Key Features
24+
25+
- **Conductor Pattern** — Instructions route to knowledge; they don't contain it
26+
- **Chunk Resilience** — Content survives Claude's 400-800 token chunking
27+
- **Hybrid Retrieval Optimisation** — Balanced for both BM25 keywords and semantic embeddings
28+
- **8 Quality Gates** — Systematic verification before delivery
29+
- **16 Anti-Patterns** — Common mistakes to avoid
30+
31+
## Quick Start
32+
33+
### 1. Deploy PRISM as a Claude Project
34+
35+
Upload the contents of `Claude Project/` to a new Claude Project:
36+
- `INSTRUCTION.md` → Project Instructions
37+
- `Project-Files/*` → Project Knowledge
38+
39+
### 2. Transform Your Prompt
40+
41+
Give Claude your monolithic prompt and ask it to apply PRISM methodology. The eight-phase process will:
42+
43+
1. **Classify** — Tag content as OPERATIONAL or REFERENCE
44+
2. **Ingest** — Extract content by layer
45+
3. **Architect** — Design domain structure
46+
4. **Instructions** — Create routing layer
47+
5. **Domain Files** — Write operational + reference files
48+
6. **Optimise** — Balance retrieval signals
49+
7. **Verify** — Test with 30+ queries
50+
8. **Package** — Organise and deliver
51+
52+
### 3. Deploy Your New System
53+
54+
Upload the generated files to a new Claude Project and run the test matrix to verify retrieval accuracy.
55+
56+
## Repository Structure
57+
58+
```
59+
├── Claude Project/ # The PRISM methodology itself
60+
│ ├── INSTRUCTION.md # Core routing instructions
61+
│ └── Project-Files/ # Phase guides, templates, reference docs
62+
63+
├── claude-code-expert-system/ # Complete example implementation
64+
│ ├── INSTRUCTIONS.md # Conductor layer
65+
│ ├── operational/ # 4 workflow files
66+
│ ├── reference/ # 15 domain files
67+
│ └── supporting/ # 5 cross-cutting files
68+
69+
└── docs/ # Architecture docs and tutorials
70+
├── SOLUTION-ARCHITECTURE.md
71+
└── Learning-how-it-works/
72+
```
73+
74+
## Example Implementation
75+
76+
The `claude-code-expert-system/` directory demonstrates PRISM v3.4 applied to Claude Code documentation:
77+
78+
- **Source:** Claude Code official documentation
79+
- **Output:** 27 files across three layers
80+
- **Test Coverage:** 35 verification queries across 7 types
81+
82+
Features demonstrated:
83+
- YAML frontmatter with semantic triggers
84+
- Tiered source authority
85+
- Cross-cutting decision matrices
86+
- Complete test matrix
87+
88+
## Documentation
89+
90+
| Document | Description |
91+
|----------|-------------|
92+
| [SOLUTION-ARCHITECTURE.md](docs/SOLUTION-ARCHITECTURE.md) | Complete technical architecture |
93+
| [CHANGELOG.md](CHANGELOG.md) | Version history and migration guides |
94+
| [Learning-how-it-works/](docs/Learning-how-it-works/) | Practical tutorials |
95+
96+
## v3.4 Highlights
97+
98+
- **YAML Frontmatter** — Machine-readable metadata in all domain files
99+
- **Tiered Source Authority** — 4-tier system for ranking authoritative sources
100+
- **Cross-Cutting Domains** — Guidance for decision matrices and bridging files
101+
- **Prompt Templates** — Ready-to-use prompts in reference files
102+
103+
## License
104+
105+
[MIT](LICENSE)
106+
107+
---
108+
109+
Built for [Claude Projects](https://claude.ai) by humans and AI working together.

0 commit comments

Comments
 (0)