Skip to content

Commit 0d83e82

Browse files
committed
Add user personas and interaction flows documentation; introduce automated upstream integration strategy for Spec Kit Spark
1 parent f38f6c8 commit 0d83e82

35 files changed

Lines changed: 8714 additions & 61 deletions

.DocSpecSpark/KeyDocuments-NotForProfits.md

Lines changed: 586 additions & 0 deletions
Large diffs are not rendered by default.

.DocSpecSpark/KeyDocuments-SmallBusiness.md

Lines changed: 773 additions & 0 deletions
Large diffs are not rendered by default.

.DocSpecSpark/README.md

Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,185 @@
1+
# DocSpecSpark - Planning Repository
2+
3+
This directory contains all planning documents for the **DocSpecSpark** project - a document-focused adaptation of Spec Kit for creating business documentation (policies, procedures, handbooks, training materials).
4+
5+
## Project Vision
6+
7+
**DocSpecSpark** is a Git-based document management system for creating, versioning, and publishing business documentation. It applies the Spec-Driven Development methodology from [Spec Kit](https://github.com/github/spec-kit) to document creation workflows.
8+
9+
### Core Principles
10+
11+
> **"Constitution as Single Source of Truth"**
12+
> All company metadata lives in `constitution.yaml`. Templates use `{{TOKENS}}` that are automatically replaced from the constitution when documents are created.
13+
14+
> **"Markdown as source of truth. Git for versioning. Static site for viewing."**
15+
> Documents are Markdown files in Git. Static site (Docusaurus) provides professional viewing. No complex CMS required.
16+
17+
### Architecture: Constitution → Templates → Documents
18+
19+
```
20+
constitution.yaml Templates (61) Documents
21+
├── company.legal_name → {{COMPANY_NAME}} → Acme Manufacturing Inc.
22+
├── company.executives.ceo → {{CEO_NAME}} → John Smith
23+
├── company.state → {{STATE}} → Ohio
24+
├── company.dept_heads.ehs → {{EHS_MANAGER}} → David Martinez
25+
└── ... (all metadata) → ... (all tokens) → ... (auto-replaced)
26+
27+
Update once in constitution → All future documents use new values
28+
```
29+
30+
**Key Benefits**:
31+
- **Consistency**: Company name, executive names, addresses are identical across all documents
32+
- **Maintainability**: Change CEO once in constitution, not in 50 documents
33+
- **Validation**: Constitution builder ensures required metadata is collected
34+
- **Auditability**: Git tracks all changes to constitution and documents
35+
36+
### MVP: The "Spark" Approach
37+
38+
The Phase 1 MVP follows the "Spark" philosophy: **minimal, fast, Git-native**. No complex workflows, no web app, no SharePoint—just:
39+
40+
1. **Constitution Builder** - Interactive questionnaire populates company metadata
41+
2. **Template Token Replacement** - `{{TOKENS}}` auto-filled from constitution
42+
3. **Markdown files** stored in Git
43+
4. **Static site** (Docusaurus) for viewing documents
44+
5. **Git tags** for version control
45+
6. **Minimal CLI** for scaffolding and publishing
46+
47+
This keeps the barrier to entry low while providing robust version control, consistent metadata, and professional document viewing.
48+
49+
## Key Design Principles (Post-MVP Evolution)
50+
51+
1. **One Repository Per Company**: Each client gets an isolated repository with their constitution, templates, and published documents
52+
2. **Multi-Interface Support (Phase 3+)**: Accessible via CLI (Phase 1) → Web app (Phase 3) → SharePoint/Teams (Phase 4)
53+
3. **Compliance-First (Phase 2)**: Multi-framework validation (ISO 9001, SOC 2, GDPR, HIPAA, Labor Law)
54+
4. **Template-Driven**: Extensive library of pre-built document templates for rapid creation
55+
5. **Hybrid Output Formats (Phase 3+)**: Markdown as source of truth, exports to MS Word/PDF with version tracking
56+
57+
## Planning Documents
58+
59+
### Getting Started
60+
- [mvp-quick-start.md](mvp-quick-start.md) - **START HERE** - Phase 1 MVP overview, user workflows, what's included/excluded
61+
- [phased-rollout-plan.md](phased-rollout-plan.md) - 4-phase delivery strategy (MVP → Enterprise)
62+
63+
### Architecture & Design
64+
- [architecture-decisions.md](architecture-decisions.md) - Multi-interface approach, GitHub API integration, SharePoint/Teams strategy
65+
- [integration-strategy.md](integration-strategy.md) - SharePoint, Teams, MS Word integration patterns (Phase 4)
66+
- [user-personas.md](user-personas.md) - Technical vs. non-technical user flows
67+
- [company-profiles.md](company-profiles.md) - 7 organizational profiles with pre-configured templates
68+
69+
### Core Components
70+
- [company-constitution-schema.md](company-constitution-schema.md) - Company metadata, compliance frameworks, document governance
71+
- [nonprofit-template-library.md](nonprofit-template-library.md) - **21 nonprofit templates** derived from KeyDocuments-NotForProfits.md analysis
72+
- [smallbusiness-template-library.md](smallbusiness-template-library.md) - **40 small business manufacturing templates** derived from KeyDocuments-SmallBusiness.md analysis
73+
- [workflow-commands.md](workflow-commands.md) - Spec → Plan → Tasks → Draft → Compliance Review → Publish
74+
75+
### Technical Specifications
76+
- [cli-design.md](cli-design.md) - Command-line interface for technical users
77+
- [web-app-design.md](web-app-design.md) - Web application for non-technical users (GitHub API-based)
78+
- [github-actions-workflows.md](github-actions-workflows.md) - Automation for document generation, compliance checks, publication
79+
80+
### Compliance & Templates
81+
- [compliance-frameworks/](compliance-frameworks/) - ISO 9001, SOC 2, GDPR, HIPAA, Labor Law specifications
82+
- [template-library/](template-library/) - Policies, handbooks, training materials
83+
84+
## Directory Structure
85+
86+
```
87+
.DocSpecSpark/
88+
├── README.md (this file)
89+
├── architecture-decisions.md
90+
├── integration-strategy.md
91+
├── user-personas.md
92+
├── company-constitution-schema.md
93+
├── document-templates-spec.md
94+
├── workflow-commands.md
95+
├── cli-design.md
96+
├── web-app-design.md
97+
├── github-actions-workflows.md
98+
├── compliance-frameworks/
99+
│ ├── iso9001-spec.md
100+
│ ├── soc2-spec.md
101+
│ ├── gdpr-spec.md
102+
│ ├── hipaa-spec.md
103+
│ └── labor-law-spec.md
104+
└── template-library/
105+
├── policies/
106+
├── handbooks/
107+
└── training/
108+
```
109+
110+
## Phased Rollout Strategy
111+
112+
DocSpecSpark will launch in **4 phases** over 12 months:
113+
114+
- **Phase 1 (Months 1-3)**: Markdown + Static Site MVP - CLI for managing documents, Docusaurus for viewing, Git for versioning
115+
- **Phase 2 (Months 4-6)**: Compliance Validation & AI Agents - Automated framework checking, AI-assisted document creation
116+
- **Phase 3 (Months 7-9)**: Web Application & Editing UI - Browser-based editor for non-technical users, MS Word export
117+
- **Phase 4 (Months 10-12)**: Enterprise Integration - SharePoint, Teams, advanced Word templates, SSO (NOT part of MVP)
118+
119+
See [phased-rollout-plan.md](phased-rollout-plan.md) for full details.
120+
121+
## Current Status
122+
123+
**Planning Phase: COMPLETE** (11/11 documents)
124+
125+
**Phase 1 MVP: "Spark" Edition** - FOCUS ON THIS
126+
- **Read**: [mvp-quick-start.md](mvp-quick-start.md) for complete Phase 1 overview
127+
- **Template Libraries**: 61 total templates (21 nonprofit + 40 small business manufacturing)
128+
- **Focus**: Markdown documents + Git versioning + Static site viewing
129+
- **Scope**: Minimal CLI, Docusaurus site, GitHub Pages hosting
130+
- **Templates**:
131+
- [nonprofit-template-library.md](nonprofit-template-library.md) - 21 nonprofit templates
132+
- [smallbusiness-template-library.md](smallbusiness-template-library.md) - 40 manufacturing templates
133+
- **Installation**: Like Spec Kit - all framework in `.docspecspark/` folder
134+
- **Timeline**: Months 1-3
135+
- **Target**: 5 pilot companies, 25 documents created
136+
137+
**Phases 2-4**: Future ideas only, not committed development.
138+
139+
### Next Steps (MVP Development)
140+
141+
1. **Create Source Repository**: `github/docspecspark` (framework development)
142+
2. **Build `.docspecspark/` Structure**:
143+
- `scripts/` (bash + PowerShell)
144+
- `templates/` (61 templates: nonprofit + manufacturing profiles)
145+
- `site-theme/` (Docusaurus theme)
146+
- `prompts/` (AI agent prompts - future)
147+
- `config.yaml` (company configuration schema)
148+
3. **Build Python CLI** (`docspec_cli`):
149+
- `install` - Install framework into target repo
150+
- `create` - Create document from template
151+
- `publish` - Tag version and deploy site
152+
- `update` - Update framework from source
153+
- `list` - List all documents
154+
4. **Create 61 Templates**:
155+
- 21 nonprofit templates (governance, HR, finance/tax - aligned to IRS Form 990)
156+
- 40 small business manufacturing templates (OSHA, EPA, QMS, engineering, export, IT security)
157+
5. **Create Example Repository**: Demo company (`acme-corp-docs`) with sample documents
158+
6. **Recruit Pilot Companies**: 5 organizations for beta testing
159+
160+
## Company Profiles
161+
162+
DocSpecSpark supports **7 company profiles** with pre-configured templates, compliance frameworks, and workflows:
163+
164+
1. **Not-for-Profit** (with volunteers and staff)
165+
2. **Early-Stage Startup** (< 10 people)
166+
3. **Small Business - Service Industry** (10-50 employees)
167+
4. **Small Business - Manufacturing** (50-250 employees)
168+
5. **Mid-Sized Enterprise** (250-1000 employees)
169+
6. **Large Enterprise** (1000+ employees)
170+
7. **Healthcare Organization** (regulated)
171+
172+
See [company-profiles.md](company-profiles.md) for detailed specifications.
173+
174+
## Status
175+
176+
**Phase**: Planning & Architecture (Complete)
177+
**Last Updated**: March 2, 2026
178+
**Next Steps**:
179+
1. ✅ Multi-interface architecture defined
180+
2. ✅ Company constitution schema created
181+
3. ✅ SharePoint/Teams integration strategy designed
182+
4. ✅ Template library specifications built
183+
5. ✅ Company profiles configured
184+
6. ✅ Phased rollout plan finalized
185+
7. **→ Begin Phase 1 development (Core MVP)**

0 commit comments

Comments
 (0)