Skip to content

Commit fe1520f

Browse files
jeremylongshoreclaude
jeremylongshore
and
claude
committed
docs: add 000-docs with doc-filing system and update README for beta
- Create 000-docs/ with 10 canonical documents (NNN-CC-ABCD format): - 000: Standards catalog and index - 001: Product vision and roadmap - 002: System architecture - 003: Template specification (22 templates) - 004: MCP server integration spec - 005: Contributing guide - 006: Security policy - 007: Release and publishing guide - 008: Plugin development guide - 009: Testing and QA - Update README.md: - Add beta status badge and notice - Add clear status table (stable/beta/planned) - Link to all 000-docs/ documents - Clean up structure for public-facing beta - Keep all existing feature documentation Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent c624b6e commit fe1520f

11 files changed

Lines changed: 952 additions & 135 deletions

‎000-docs/000-DR-INDEX-standards-catalog.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Intent Blueprint Docs - Standards Catalog
2+
3+
Master index of all canonical documents for the Intent Blueprint Docs project.
4+
5+
## Document Filing System
6+
7+
All docs follow format: `NNN-CC-ABCD-description.md`
8+
9+
- **NNN** = Sequential number (000-999)
10+
- **CC** = Category code
11+
- **ABCD** = Document type (4-letter abbreviation)
12+
13+
### Category Codes
14+
15+
| Code | Category |
16+
|------|----------|
17+
| PP | Product & Planning |
18+
| AT | Architecture & Technical |
19+
| DR | Documentation & Reference |
20+
| TQ | Testing & Quality |
21+
| OD | Operations & Deployment |
22+
| LS | Logs & Status |
23+
| PM | Project Management |
24+
25+
## Document Index
26+
27+
| # | Code | Title | Status |
28+
|---|------|-------|--------|
29+
| 000 | DR-INDEX | Standards Catalog (this doc) | Active |
30+
| 001 | PP-VISN | Product Vision and Roadmap | Active |
31+
| 002 | AT-ARCH | System Architecture | Active |
32+
| 003 | DR-SPEC | Template Specification | Active |
33+
| 004 | DR-SPEC | MCP Server Integration | Active |
34+
| 005 | DR-GUID | Contributing Guide | Active |
35+
| 006 | AT-SECR | Security Policy | Active |
36+
| 007 | OD-OPER | Release and Publishing Guide | Active |
37+
| 008 | DR-GUID | Plugin Development Guide | Active |
38+
| 009 | TQ-TEST | Testing and Quality Assurance | Active |

‎000-docs/001-PP-VISN-product-vision-and-roadmap.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# 001 - Product Vision and Roadmap
2+
3+
## Vision
4+
5+
Intent Blueprint Docs transforms project ideas into comprehensive, professional documentation in minutes. It is the standard tool for AI-assisted documentation generation, working natively with Claude, Cursor, VS Code, and any MCP-compatible environment.
6+
7+
## Core Value Proposition
8+
9+
- **Speed**: 22 professional documents from a single project description
10+
- **Quality**: Enterprise-grade templates with consistent structure and formatting
11+
- **Flexibility**: CLI, MCP server, IDE integration, and programmatic API
12+
- **Extensibility**: Plugin system, template marketplace, and custom template packs
13+
14+
## Product Pillars
15+
16+
### 1. Template Engine
17+
The foundation: 22 professionally crafted templates covering product strategy, technical architecture, user experience, development workflow, and quality assurance.
18+
19+
### 2. AI Integration (MCP-First)
20+
Native Model Context Protocol integration makes Blueprint a first-class tool for any AI agent or IDE that supports MCP.
21+
22+
### 3. Enterprise Pipeline
23+
Structured 17-question intake with governance controls, CODEOWNERS protection, and CI/CD integration for organizations.
24+
25+
### 4. Ecosystem
26+
Template marketplace, plugin system, and community-contributed template packs for verticals (FinTech, HealthTech, SaaS) and compliance frameworks (SOC 2, HIPAA, GDPR).
27+
28+
## Current Status
29+
30+
**Version:** 2.0.0 (Beta)
31+
32+
### Completed
33+
- 22 professional templates with dynamic date placeholders
34+
- CLI tool (`@intentsolutions/blueprint`)
35+
- MCP server (`@intentsolutions/blueprint-mcp`)
36+
- Core engine (`@intentsolutions/blueprint-core`)
37+
- Dual AI support (Claude Code CLI + Cursor IDE)
38+
- Enterprise pipeline with 17-question intake
39+
- GitHub Actions CI/CD
40+
- Template marketplace framework
41+
- Plugin system architecture
42+
- Analytics dashboard
43+
44+
### In Development (Beta)
45+
- Template pack publishing workflow
46+
- Web UI for non-technical users
47+
- Team collaboration features
48+
- Enhanced export integrations (Linear, Jira, Notion)
49+
50+
### Planned
51+
- Slack/Discord bot integration
52+
- Custom branding per organization
53+
- Multi-language template support
54+
- Real-time collaborative editing
55+
56+
## Packages
57+
58+
| Package | Description | Status |
59+
|---------|-------------|--------|
60+
| `@intentsolutions/blueprint` | CLI tool | Beta |
61+
| `@intentsolutions/blueprint-mcp` | MCP server | Beta |
62+
| `@intentsolutions/blueprint-core` | Core engine | Beta |
63+
64+
## Documentation Scopes
65+
66+
| Scope | Documents | Target |
67+
|-------|-----------|--------|
68+
| MVP | 4 docs | Quick starts, prototypes |
69+
| Standard | 12 docs | Most projects |
70+
| Comprehensive | 22 docs | Enterprise, compliance |

‎000-docs/002-AT-ARCH-system-architecture.md‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
# 002 - System Architecture
2+
3+
## Overview
4+
5+
Intent Blueprint Docs is a monorepo with three publishable packages, a template engine, and supporting infrastructure.
6+
7+
## Architecture Diagram
8+
9+
```
10+
┌─────────────────────────────┐
11+
│ User Interfaces │
12+
├──────────┬──────────┬────────┤
13+
│ CLI │ MCP │ IDE │
14+
│ (npx) │ Server │ Plugin │
15+
└────┬─────┴────┬─────┴───┬────┘
16+
│ │ │
17+
┌────▼──────────▼─────────▼────┐
18+
│ @intentsolutions/ │
19+
│ blueprint-core │
20+
│ │
21+
│ ┌──────────┐ ┌───────────┐ │
22+
│ │ Template │ │ Plugin │ │
23+
│ │ Engine │ │ Manager │ │
24+
│ └────┬─────┘ └─────┬─────┘ │
25+
│ │ │ │
26+
│ ┌────▼─────────────▼─────┐ │
27+
│ │ Document Generator │ │
28+
│ └────────────┬────────────┘ │
29+
└──────────────┼────────────────┘
30+
│
31+
┌──────────────▼────────────────┐
32+
│ Output Layer │
33+
├──────┬───────┬────────┬───────┤
34+
│ Files│GitHub │ Linear │ Notion │
35+
└──────┴───────┴────────┴───────┘
36+
```
37+
38+
## Package Structure
39+
40+
```
41+
intent-blueprint-docs/
42+
├── packages/
43+
│ ├── cli/ # @intentsolutions/blueprint
44+
│ │ ├── src/
45+
│ │ │ ├── commands/ # CLI command handlers
46+
│ │ │ ├── interview/ # AI-guided interview engine
47+
│ │ │ └── index.ts # CLI entrypoint
48+
│ │ └── package.json
49+
│ │
50+
│ └── chatbots/ # MCP server + chatbot integrations
51+
│ ├── src/
52+
│ │ ├── mcp/ # MCP tool definitions
53+
│ │ └── index.ts
54+
│ └── package.json
55+
│
56+
├── professional-templates/ # 22 master templates (READ-ONLY)
57+
├── form-system/ # Interactive CLI form tools
58+
├── 000-docs/ # Project documentation (doc-filing system)
59+
├── 01-Docs/ # Legacy docs (migrating to 000-docs/)
60+
└── .github/workflows/ # CI/CD pipelines
61+
```
62+
63+
## Key Components
64+
65+
### Template Engine
66+
- Reads templates from `professional-templates/`
67+
- Replaces `{{DATE}}` and other placeholders
68+
- Validates template completeness
69+
- Supports scope filtering (MVP/Standard/Comprehensive)
70+
71+
### Plugin System
72+
- Five plugin types: Formatter, Validator, Processor, Integration, Hook
73+
- Lifecycle hooks: before/after generation
74+
- Built-in plugins: markdown-formatter, html-formatter, quality-validator
75+
76+
### MCP Server
77+
- Exposes 5 tools: generate, interview, list_templates, customize, export
78+
- Stateless design - each call is independent
79+
- Works with Claude, Cursor, VS Code, and any MCP client
80+
81+
### Enterprise Pipeline
82+
- 17-question structured intake (`scripts/run-enterprise.mjs`)
83+
- Governance controls and CODEOWNERS protection
84+
- CI/CD integration via GitHub Actions
85+
- Automated E2E validation
86+
87+
## Technology Stack
88+
89+
| Component | Technology |
90+
|-----------|-----------|
91+
| Language | TypeScript 5.3+ |
92+
| Runtime | Node.js 18+ |
93+
| Build | Turbo (monorepo) |
94+
| Package Manager | npm (workspaces) |
95+
| CI/CD | GitHub Actions |
96+
| Templates | Markdown with placeholders |
97+
| MCP | Model Context Protocol SDK |
98+
99+
## Build System
100+
101+
Turborepo manages the monorepo with these pipelines:
102+
103+
```json
104+
{
105+
"build": { "dependsOn": ["^build"] },
106+
"dev": { "persistent": true },
107+
"lint": {},
108+
"test": { "dependsOn": ["build"] }
109+
}
110+
```

‎000-docs/003-DR-SPEC-template-specification.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# 003 - Template Specification
2+
3+
## Overview
4+
5+
Intent Blueprint Docs ships 22 professional document templates organized into 5 categories. Templates are the atomic unit of the system.
6+
7+
## Template Categories
8+
9+
### Product & Strategy (5 templates)
10+
1. **PRD** - Product Requirements Document
11+
2. **Market Research** - Market analysis and opportunity assessment
12+
3. **Competitor Analysis** - Competitive landscape mapping
13+
4. **User Personas** - Target user profiles and needs
14+
5. **Project Brief** - Executive summary and project scope
15+
16+
### Technical Architecture (4 templates)
17+
6. **ADRs** - Architecture Decision Records
18+
7. **System Architecture** - Technical system design
19+
8. **Frontend Spec** - Frontend implementation specification
20+
9. **Operational Readiness** - Production readiness checklist
21+
22+
### User Experience (3 templates)
23+
10. **User Stories** - Agile user stories with acceptance criteria
24+
11. **User Journeys** - End-to-end user flow maps
25+
12. **Acceptance Criteria** - Detailed acceptance criteria per feature
26+
27+
### Development Workflow (5 templates)
28+
13. **Task Generation** - Development task breakdown
29+
14. **Task Processing** - Sprint planning and execution
30+
15. **Risk Register** - Risk identification and mitigation
31+
16. **Brainstorming** - Ideation and feature exploration
32+
17. **Metrics** - KPI and success metric definitions
33+
34+
### Quality Assurance (5 templates)
35+
18. **Test Plan** - Test strategy and coverage plan
36+
19. **QA Gates** - Quality gate definitions and criteria
37+
20. **Release Plan** - Release process and checklist
38+
21. **Post-Mortem** - Incident review template
39+
22. **Usability Testing** - UX testing protocols
40+
41+
## Scope Tiers
42+
43+
| Scope | Templates Included |
44+
|-------|-------------------|
45+
| **MVP** (4) | PRD, System Architecture, User Stories, Task Generation |
46+
| **Standard** (12) | MVP + Market Research, ADRs, Frontend Spec, User Journeys, Risk Register, Metrics, Test Plan, Release Plan |
47+
| **Comprehensive** (22) | All templates |
48+
49+
## Template Format
50+
51+
Each template is a Markdown file in `professional-templates/` with:
52+
53+
```markdown
54+
# [Template Title]
55+
56+
> Generated by Intent Blueprint Docs | {{DATE}}
57+
58+
## Section 1
59+
[Guidance text with placeholders]
60+
61+
## Section 2
62+
[Structured content areas]
63+
```
64+
65+
### Placeholder System
66+
67+
| Placeholder | Replaced With |
68+
|-------------|--------------|
69+
| `{{DATE}}` | Current date (ISO 8601) |
70+
| `{{PROJECT_NAME}}` | User-provided project name |
71+
| `{{PROJECT_DESC}}` | User-provided description |
72+
73+
## Rules
74+
75+
1. **Templates are READ-ONLY** - Never modify files in `professional-templates/`
76+
2. **Generated docs go to `completed-docs/`** - Separate from source templates
77+
3. **Placeholders are mandatory** - All templates must use `{{DATE}}` at minimum
78+
4. **Metadata is consistent** - Header format is standardized across all templates
79+
80+
## Adding New Templates
81+
82+
1. Create template in `professional-templates/` following the format above
83+
2. Add to scope tier mapping in the core engine
84+
3. Run `make verify` to validate template count and format
85+
4. Update this spec with the new template entry

0 commit comments

Comments
 (0)