kitfly 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +60 -0
- package/LICENSE +21 -0
- package/README.md +136 -0
- package/VERSION +1 -0
- package/package.json +63 -0
- package/schemas/README.md +32 -0
- package/schemas/site.schema.json +5 -0
- package/schemas/theme.schema.json +5 -0
- package/schemas/v0/site.schema.json +172 -0
- package/schemas/v0/theme.schema.json +210 -0
- package/scripts/build-all.ts +121 -0
- package/scripts/build.ts +601 -0
- package/scripts/bundle.ts +781 -0
- package/scripts/dev.ts +777 -0
- package/scripts/generate-checksums.sh +78 -0
- package/scripts/release/export-release-key.sh +28 -0
- package/scripts/release/release-guard-tag-version.sh +79 -0
- package/scripts/release/sign-release-assets.sh +123 -0
- package/scripts/release/upload-release-assets.sh +76 -0
- package/scripts/release/upload-release-provenance.sh +52 -0
- package/scripts/release/verify-public-key.sh +48 -0
- package/scripts/release/verify-signatures.sh +117 -0
- package/scripts/version-sync.ts +82 -0
- package/src/__tests__/build.test.ts +240 -0
- package/src/__tests__/bundle.test.ts +786 -0
- package/src/__tests__/cli.test.ts +706 -0
- package/src/__tests__/crucible.test.ts +1043 -0
- package/src/__tests__/engine.test.ts +157 -0
- package/src/__tests__/init.test.ts +450 -0
- package/src/__tests__/pipeline.test.ts +1087 -0
- package/src/__tests__/productbook.test.ts +1206 -0
- package/src/__tests__/runbook.test.ts +974 -0
- package/src/__tests__/server-registry.test.ts +1251 -0
- package/src/__tests__/servicebook.test.ts +1248 -0
- package/src/__tests__/shared.test.ts +2005 -0
- package/src/__tests__/styles.test.ts +14 -0
- package/src/__tests__/theme-schema.test.ts +47 -0
- package/src/__tests__/theme.test.ts +554 -0
- package/src/cli.ts +582 -0
- package/src/commands/init.ts +92 -0
- package/src/commands/update.ts +444 -0
- package/src/engine.ts +20 -0
- package/src/logger.ts +15 -0
- package/src/migrations/0000_schema_versioning.ts +67 -0
- package/src/migrations/0001_server_port.ts +52 -0
- package/src/migrations/0002_brand_logo.ts +49 -0
- package/src/migrations/index.ts +26 -0
- package/src/migrations/schema.ts +24 -0
- package/src/server-registry.ts +405 -0
- package/src/shared.ts +1239 -0
- package/src/site/styles.css +931 -0
- package/src/site/template.html +193 -0
- package/src/templates/crucible.ts +1163 -0
- package/src/templates/driver.ts +876 -0
- package/src/templates/handbook.ts +339 -0
- package/src/templates/minimal.ts +139 -0
- package/src/templates/pipeline.ts +966 -0
- package/src/templates/productbook.ts +1032 -0
- package/src/templates/runbook.ts +829 -0
- package/src/templates/schema.ts +119 -0
- package/src/templates/servicebook.ts +1242 -0
- package/src/theme.ts +245 -0
|
@@ -0,0 +1,1242 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Servicebook Template
|
|
3
|
+
*
|
|
4
|
+
* Extends minimal with structured sections for professional services documentation.
|
|
5
|
+
* Designed for consulting practices, technical assessments, and service delivery.
|
|
6
|
+
* Sections: Offerings, Methodology, Delivery, Verticals, Case Studies, Reference
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
import type { TemplateContext, TemplateDef } from "./schema.ts";
|
|
10
|
+
|
|
11
|
+
export const servicebook: TemplateDef = {
|
|
12
|
+
id: "servicebook",
|
|
13
|
+
name: "Servicebook",
|
|
14
|
+
description:
|
|
15
|
+
"Professional services catalog with offerings, methodology, and delivery documentation",
|
|
16
|
+
version: 1,
|
|
17
|
+
extends: "minimal",
|
|
18
|
+
sections: [
|
|
19
|
+
{
|
|
20
|
+
name: "Offerings",
|
|
21
|
+
path: "content/offerings",
|
|
22
|
+
description: "Service tiers, engagement models, per-service deliverables and scoping",
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
name: "Methodology",
|
|
26
|
+
path: "content/methodology",
|
|
27
|
+
description: "Phases, tools, frameworks, and decisions (ADRs)",
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
name: "Delivery",
|
|
31
|
+
path: "content/delivery",
|
|
32
|
+
description: "Engagement lifecycle, onboarding, quality gates, deliverable templates",
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
name: "Verticals",
|
|
36
|
+
path: "content/verticals",
|
|
37
|
+
description: "Industry context — client domains, regulations, competitive landscape",
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
name: "Case Studies",
|
|
41
|
+
path: "content/case-studies",
|
|
42
|
+
description: "Past engagements, anonymized — proof of capability",
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
name: "Reference",
|
|
46
|
+
path: "content/reference",
|
|
47
|
+
description: "Team expertise, pricing models, contacts",
|
|
48
|
+
},
|
|
49
|
+
],
|
|
50
|
+
files: [
|
|
51
|
+
{
|
|
52
|
+
path: "site.yaml",
|
|
53
|
+
content: (ctx: TemplateContext) => `# ${ctx.branding.siteName} - Site Configuration
|
|
54
|
+
# Documentation: https://github.com/3leaps/kitfly
|
|
55
|
+
|
|
56
|
+
title: "${ctx.branding.siteName}"
|
|
57
|
+
|
|
58
|
+
# \u2190 CUSTOMIZE: Your brand settings
|
|
59
|
+
brand:
|
|
60
|
+
name: "${ctx.branding.brandName}"
|
|
61
|
+
url: "${ctx.branding.brandUrl}"
|
|
62
|
+
# external: false # Set true if brand URL is external
|
|
63
|
+
|
|
64
|
+
# Content sections
|
|
65
|
+
sections:
|
|
66
|
+
- name: "Offerings"
|
|
67
|
+
path: "content/offerings"
|
|
68
|
+
- name: "Methodology"
|
|
69
|
+
path: "content/methodology"
|
|
70
|
+
- name: "Delivery"
|
|
71
|
+
path: "content/delivery"
|
|
72
|
+
- name: "Verticals"
|
|
73
|
+
path: "content/verticals"
|
|
74
|
+
- name: "Case Studies"
|
|
75
|
+
path: "content/case-studies"
|
|
76
|
+
- name: "Reference"
|
|
77
|
+
path: "content/reference"
|
|
78
|
+
|
|
79
|
+
# Home page
|
|
80
|
+
home: "index.md"
|
|
81
|
+
`,
|
|
82
|
+
},
|
|
83
|
+
{
|
|
84
|
+
path: "index.md",
|
|
85
|
+
content: (ctx: TemplateContext) => `---
|
|
86
|
+
title: Home
|
|
87
|
+
description: ${ctx.branding.siteName} - Professional Services Catalog
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
# ${ctx.branding.siteName}
|
|
91
|
+
|
|
92
|
+
Professional services catalog and delivery documentation for ${ctx.branding.brandName}.
|
|
93
|
+
|
|
94
|
+
## Service Offerings
|
|
95
|
+
|
|
96
|
+
| Service | Engagement Model | Typical Duration | Status |
|
|
97
|
+
|---------|-----------------|------------------|--------|
|
|
98
|
+
| Assessment | Fixed-scope | 2\u20134 weeks | Active |
|
|
99
|
+
| Advisory | Retainer | Ongoing | Active |
|
|
100
|
+
| Implementation | Milestone-based | 8\u201316 weeks | Active |
|
|
101
|
+
|
|
102
|
+
## Quick Links
|
|
103
|
+
|
|
104
|
+
### [Service Catalog](/content/offerings/overview)
|
|
105
|
+
What we deliver \u2014 service tiers, engagement models, and scoping.
|
|
106
|
+
|
|
107
|
+
### [Our Methodology](/content/methodology/phases)
|
|
108
|
+
How we work \u2014 phases, tools, and frameworks.
|
|
109
|
+
|
|
110
|
+
### [Engagement Lifecycle](/content/delivery/engagement-lifecycle)
|
|
111
|
+
End-to-end delivery from kickoff to close-out.
|
|
112
|
+
|
|
113
|
+
### [Case Studies](/content/case-studies/)
|
|
114
|
+
Past engagements and proven results.
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
*Last updated: ${new Date().toISOString().split("T")[0]}*
|
|
119
|
+
`,
|
|
120
|
+
},
|
|
121
|
+
// ---------------------------------------------------------------
|
|
122
|
+
// Offerings section
|
|
123
|
+
// ---------------------------------------------------------------
|
|
124
|
+
{
|
|
125
|
+
path: "content/offerings/overview.md",
|
|
126
|
+
content: (ctx: TemplateContext) => `---
|
|
127
|
+
title: Service Catalog
|
|
128
|
+
description: Service offerings for ${ctx.branding.brandName}
|
|
129
|
+
---
|
|
130
|
+
|
|
131
|
+
# Service Catalog
|
|
132
|
+
|
|
133
|
+
<!-- \u2190 CUSTOMIZE: Replace with your service offerings -->
|
|
134
|
+
|
|
135
|
+
## Service Tiers
|
|
136
|
+
|
|
137
|
+
| Tier | Description | Typical Client | Duration |
|
|
138
|
+
|------|-------------|----------------|----------|
|
|
139
|
+
| Assessment | Evaluate current state, identify gaps, recommend actions | New clients, scoping | 2\u20134 weeks |
|
|
140
|
+
| Advisory | Ongoing strategic guidance and decision support | Established clients | Retainer |
|
|
141
|
+
| Implementation | Hands-on delivery of solutions and capabilities | Clients with defined scope | 8\u201316 weeks |
|
|
142
|
+
|
|
143
|
+
## Engagement Models
|
|
144
|
+
|
|
145
|
+
### Fixed-Scope
|
|
146
|
+
|
|
147
|
+
Defined deliverables, timeline, and price. Best for assessments and well-defined projects.
|
|
148
|
+
|
|
149
|
+
### Time & Materials
|
|
150
|
+
|
|
151
|
+
Flexible scope with regular check-ins. Best for advisory and evolving requirements.
|
|
152
|
+
|
|
153
|
+
### Milestone-Based
|
|
154
|
+
|
|
155
|
+
Payments tied to deliverable acceptance. Best for implementation engagements.
|
|
156
|
+
|
|
157
|
+
## Pricing Approach
|
|
158
|
+
|
|
159
|
+
See [Pricing Models](/content/reference/pricing-models) for engagement pricing structures.
|
|
160
|
+
|
|
161
|
+
## Service Details
|
|
162
|
+
|
|
163
|
+
| Service | Details |
|
|
164
|
+
|---------|---------|
|
|
165
|
+
| [Assessment](/content/offerings/assess/overview) | Current-state evaluation with recommendations |
|
|
166
|
+
|
|
167
|
+
## Related
|
|
168
|
+
|
|
169
|
+
- [Methodology](/content/methodology/phases) \u2014 how we deliver
|
|
170
|
+
- [Delivery Lifecycle](/content/delivery/engagement-lifecycle) \u2014 engagement operations
|
|
171
|
+
- [Pricing Models](/content/reference/pricing-models) \u2014 commercial structures
|
|
172
|
+
`,
|
|
173
|
+
},
|
|
174
|
+
{
|
|
175
|
+
path: "content/offerings/assess/overview.md",
|
|
176
|
+
content: (_ctx: TemplateContext) => `---
|
|
177
|
+
title: Assessment Service
|
|
178
|
+
description: Current-state evaluation and recommendations
|
|
179
|
+
---
|
|
180
|
+
|
|
181
|
+
# Assessment Service
|
|
182
|
+
|
|
183
|
+
<!-- \u2190 CUSTOMIZE: Replace with your assessment service details -->
|
|
184
|
+
|
|
185
|
+
## What It Is
|
|
186
|
+
|
|
187
|
+
A structured evaluation of a client\u2019s current state against best practices, producing prioritized recommendations and a roadmap.
|
|
188
|
+
|
|
189
|
+
## Client Problem
|
|
190
|
+
|
|
191
|
+
<!-- What problem does this service solve for the client? -->
|
|
192
|
+
|
|
193
|
+
Clients need an objective, expert evaluation when:
|
|
194
|
+
- Starting a new initiative and unsure where to focus
|
|
195
|
+
- Existing approaches aren\u2019t delivering expected results
|
|
196
|
+
- Regulatory or market changes require reassessment
|
|
197
|
+
|
|
198
|
+
## Deliverables
|
|
199
|
+
|
|
200
|
+
| Deliverable | Format | Description |
|
|
201
|
+
|-------------|--------|-------------|
|
|
202
|
+
| Current-State Report | Document | Findings from discovery and analysis |
|
|
203
|
+
| Gap Analysis | Matrix | Current vs desired state with severity |
|
|
204
|
+
| Recommendations | Prioritized list | Actions ranked by impact and feasibility |
|
|
205
|
+
| Roadmap | Timeline | Phased implementation plan |
|
|
206
|
+
|
|
207
|
+
## Timeline
|
|
208
|
+
|
|
209
|
+
| Phase | Duration | Activities |
|
|
210
|
+
|-------|----------|------------|
|
|
211
|
+
| Discovery | Week 1 | Stakeholder interviews, data collection |
|
|
212
|
+
| Analysis | Week 2 | Gap analysis, benchmarking |
|
|
213
|
+
| Synthesis | Week 3 | Recommendations, roadmap development |
|
|
214
|
+
| Delivery | Week 4 | Report presentation, Q&A |
|
|
215
|
+
|
|
216
|
+
## Scoping
|
|
217
|
+
|
|
218
|
+
See [Assessment Scoping](/content/offerings/assess/scoping) for how we scope this engagement.
|
|
219
|
+
|
|
220
|
+
## Related
|
|
221
|
+
|
|
222
|
+
- [Deliverables](/content/offerings/assess/deliverables) \u2014 what the client receives
|
|
223
|
+
- [Scoping](/content/offerings/assess/scoping) \u2014 how we scope an engagement
|
|
224
|
+
- [Methodology Phases](/content/methodology/phases) \u2014 our delivery approach
|
|
225
|
+
`,
|
|
226
|
+
},
|
|
227
|
+
{
|
|
228
|
+
path: "content/offerings/assess/deliverables.md",
|
|
229
|
+
content: (_ctx: TemplateContext) => `---
|
|
230
|
+
title: Assessment Deliverables
|
|
231
|
+
description: What the client receives from an assessment engagement
|
|
232
|
+
---
|
|
233
|
+
|
|
234
|
+
# Assessment Deliverables
|
|
235
|
+
|
|
236
|
+
<!-- \u2190 CUSTOMIZE: Replace with your actual deliverable descriptions -->
|
|
237
|
+
|
|
238
|
+
## Current-State Report
|
|
239
|
+
|
|
240
|
+
A comprehensive document capturing findings from discovery:
|
|
241
|
+
|
|
242
|
+
- Executive summary (1\u20132 pages)
|
|
243
|
+
- Detailed findings organized by area
|
|
244
|
+
- Evidence and data supporting each finding
|
|
245
|
+
- Stakeholder interview summaries (anonymized)
|
|
246
|
+
|
|
247
|
+
## Gap Analysis
|
|
248
|
+
|
|
249
|
+
A structured comparison of current state vs desired state:
|
|
250
|
+
|
|
251
|
+
| Area | Current State | Desired State | Gap Severity | Notes |
|
|
252
|
+
|------|--------------|---------------|-------------|-------|
|
|
253
|
+
| <!-- area --> | <!-- description --> | <!-- target --> | High / Medium / Low | <!-- context --> |
|
|
254
|
+
|
|
255
|
+
## Recommendations
|
|
256
|
+
|
|
257
|
+
Prioritized actions ranked by:
|
|
258
|
+
- **Impact**: How much improvement this delivers
|
|
259
|
+
- **Feasibility**: How practical to implement
|
|
260
|
+
- **Dependencies**: What else must happen first
|
|
261
|
+
|
|
262
|
+
## Roadmap
|
|
263
|
+
|
|
264
|
+
Phased implementation plan showing:
|
|
265
|
+
- Quick wins (0\u201330 days)
|
|
266
|
+
- Medium-term initiatives (1\u20133 months)
|
|
267
|
+
- Strategic investments (3\u201312 months)
|
|
268
|
+
|
|
269
|
+
## Deliverable Templates
|
|
270
|
+
|
|
271
|
+
See [Deliverable Templates](/content/delivery/templates/) for report shells and formats.
|
|
272
|
+
`,
|
|
273
|
+
},
|
|
274
|
+
{
|
|
275
|
+
path: "content/offerings/assess/scoping.md",
|
|
276
|
+
content: (_ctx: TemplateContext) => `---
|
|
277
|
+
title: Assessment Scoping
|
|
278
|
+
description: How we scope an assessment engagement
|
|
279
|
+
---
|
|
280
|
+
|
|
281
|
+
# Assessment Scoping
|
|
282
|
+
|
|
283
|
+
<!-- \u2190 CUSTOMIZE: Replace with your scoping approach -->
|
|
284
|
+
|
|
285
|
+
## Scoping Criteria
|
|
286
|
+
|
|
287
|
+
| Factor | Questions | Impact on Scope |
|
|
288
|
+
|--------|-----------|----------------|
|
|
289
|
+
| Organization size | How many teams/departments? | Number of stakeholder interviews |
|
|
290
|
+
| Geographic spread | Single site or distributed? | Discovery logistics |
|
|
291
|
+
| Domain complexity | Regulated industry? Legacy systems? | Analysis depth |
|
|
292
|
+
| Prior assessments | Has this been evaluated before? | Baseline availability |
|
|
293
|
+
| Decision timeline | When do they need results? | Compression vs thoroughness |
|
|
294
|
+
|
|
295
|
+
## Scoping Process
|
|
296
|
+
|
|
297
|
+
### 1. Discovery Call
|
|
298
|
+
|
|
299
|
+
30\u201360 minute call to understand:
|
|
300
|
+
- Client context and goals
|
|
301
|
+
- Scope boundaries (what\u2019s in, what\u2019s out)
|
|
302
|
+
- Key stakeholders to interview
|
|
303
|
+
- Timeline constraints
|
|
304
|
+
- Budget parameters
|
|
305
|
+
|
|
306
|
+
### 2. Scope Document
|
|
307
|
+
|
|
308
|
+
Written scope including:
|
|
309
|
+
- Objectives and success criteria
|
|
310
|
+
- Areas included and excluded
|
|
311
|
+
- Number and type of interviews
|
|
312
|
+
- Deliverables and timeline
|
|
313
|
+
- Assumptions and dependencies
|
|
314
|
+
|
|
315
|
+
### 3. Client Approval
|
|
316
|
+
|
|
317
|
+
Scope document signed before engagement begins.
|
|
318
|
+
|
|
319
|
+
## Scope Variables
|
|
320
|
+
|
|
321
|
+
| Variable | Small | Medium | Large |
|
|
322
|
+
|----------|-------|--------|-------|
|
|
323
|
+
| Stakeholder interviews | 3\u20135 | 6\u201310 | 11\u201320 |
|
|
324
|
+
| Areas evaluated | 2\u20133 | 4\u20136 | 7\u201310 |
|
|
325
|
+
| Report pages | 15\u201325 | 30\u201350 | 60\u2013100 |
|
|
326
|
+
| Duration | 2 weeks | 3 weeks | 4\u20136 weeks |
|
|
327
|
+
`,
|
|
328
|
+
},
|
|
329
|
+
// ---------------------------------------------------------------
|
|
330
|
+
// Methodology section
|
|
331
|
+
// ---------------------------------------------------------------
|
|
332
|
+
{
|
|
333
|
+
path: "content/methodology/phases.md",
|
|
334
|
+
content: (ctx: TemplateContext) => `---
|
|
335
|
+
title: Methodology Phases
|
|
336
|
+
description: Delivery methodology for ${ctx.branding.brandName}
|
|
337
|
+
---
|
|
338
|
+
|
|
339
|
+
# Methodology Phases
|
|
340
|
+
|
|
341
|
+
<!-- \u2190 CUSTOMIZE: Replace with your methodology -->
|
|
342
|
+
|
|
343
|
+
## Overview
|
|
344
|
+
|
|
345
|
+
Our delivery follows a structured methodology adapted to engagement type and client context.
|
|
346
|
+
|
|
347
|
+
## Phases
|
|
348
|
+
|
|
349
|
+
### 1. Explore
|
|
350
|
+
|
|
351
|
+
**Purpose**: Understand the client\u2019s current state, goals, and constraints.
|
|
352
|
+
|
|
353
|
+
| Input | Activities | Output |
|
|
354
|
+
|-------|-----------|--------|
|
|
355
|
+
| Client brief | Stakeholder interviews | Discovery findings |
|
|
356
|
+
| Existing documentation | Data collection | Stakeholder map |
|
|
357
|
+
| | Environment access | Current-state inventory |
|
|
358
|
+
|
|
359
|
+
### 2. Analyze
|
|
360
|
+
|
|
361
|
+
**Purpose**: Identify gaps, patterns, and opportunities.
|
|
362
|
+
|
|
363
|
+
| Input | Activities | Output |
|
|
364
|
+
|-------|-----------|--------|
|
|
365
|
+
| Discovery findings | Gap analysis | Gap matrix |
|
|
366
|
+
| Industry benchmarks | Pattern identification | Insight catalog |
|
|
367
|
+
| | Root cause analysis | Problem statements |
|
|
368
|
+
|
|
369
|
+
### 3. Synthesize
|
|
370
|
+
|
|
371
|
+
**Purpose**: Develop recommendations and a path forward.
|
|
372
|
+
|
|
373
|
+
| Input | Activities | Output |
|
|
374
|
+
|-------|-----------|--------|
|
|
375
|
+
| Gap matrix | Recommendation development | Prioritized recommendations |
|
|
376
|
+
| Insight catalog | Roadmap planning | Implementation roadmap |
|
|
377
|
+
| | Deliverable authoring | Final report |
|
|
378
|
+
|
|
379
|
+
### 4. Deliver
|
|
380
|
+
|
|
381
|
+
**Purpose**: Present findings, transfer knowledge, and support next steps.
|
|
382
|
+
|
|
383
|
+
| Input | Activities | Output |
|
|
384
|
+
|-------|-----------|--------|
|
|
385
|
+
| Final report | Presentation to stakeholders | Accepted deliverables |
|
|
386
|
+
| Roadmap | Q&A session | Client action plan |
|
|
387
|
+
| | Knowledge transfer | Handoff documentation |
|
|
388
|
+
|
|
389
|
+
## Phase Adaptation
|
|
390
|
+
|
|
391
|
+
Not every engagement uses every phase at the same depth:
|
|
392
|
+
|
|
393
|
+
| Engagement Type | Explore | Analyze | Synthesize | Deliver |
|
|
394
|
+
|----------------|---------|---------|-----------|---------|
|
|
395
|
+
| Assessment | Deep | Deep | Medium | Standard |
|
|
396
|
+
| Advisory | Light | Medium | Light | Ongoing |
|
|
397
|
+
| Implementation | Medium | Light | Light | Deep |
|
|
398
|
+
|
|
399
|
+
## Related
|
|
400
|
+
|
|
401
|
+
- [Tools](/content/methodology/tools) \u2014 tools used in delivery
|
|
402
|
+
- [Frameworks](/content/methodology/frameworks) \u2014 assessment and scoring models
|
|
403
|
+
- [Decisions](/content/methodology/decisions/) \u2014 methodology decision records
|
|
404
|
+
`,
|
|
405
|
+
},
|
|
406
|
+
{
|
|
407
|
+
path: "content/methodology/tools.md",
|
|
408
|
+
content: (_ctx: TemplateContext) => `---
|
|
409
|
+
title: Tools
|
|
410
|
+
description: Tools used in service delivery
|
|
411
|
+
---
|
|
412
|
+
|
|
413
|
+
# Tools
|
|
414
|
+
|
|
415
|
+
<!-- \u2190 CUSTOMIZE: Replace with your delivery tools -->
|
|
416
|
+
|
|
417
|
+
## Discovery Tools
|
|
418
|
+
|
|
419
|
+
| Tool | Purpose | When Used |
|
|
420
|
+
|------|---------|-----------|
|
|
421
|
+
| <!-- tool --> | <!-- capability --> | <!-- phase/context --> |
|
|
422
|
+
|
|
423
|
+
## Analysis Tools
|
|
424
|
+
|
|
425
|
+
| Tool | Purpose | When Used |
|
|
426
|
+
|------|---------|-----------|
|
|
427
|
+
| <!-- tool --> | <!-- capability --> | <!-- phase/context --> |
|
|
428
|
+
|
|
429
|
+
## Documentation Tools
|
|
430
|
+
|
|
431
|
+
| Tool | Purpose | When Used |
|
|
432
|
+
|------|---------|-----------|
|
|
433
|
+
| <!-- tool --> | <!-- capability --> | <!-- phase/context --> |
|
|
434
|
+
|
|
435
|
+
## Collaboration Tools
|
|
436
|
+
|
|
437
|
+
| Tool | Purpose | When Used |
|
|
438
|
+
|------|---------|-----------|
|
|
439
|
+
| <!-- tool --> | <!-- capability --> | <!-- phase/context --> |
|
|
440
|
+
|
|
441
|
+
## Tool Selection Criteria
|
|
442
|
+
|
|
443
|
+
When adding a new tool to the methodology:
|
|
444
|
+
1. Does it solve a real problem in delivery?
|
|
445
|
+
2. Can the team learn it quickly?
|
|
446
|
+
3. Does it work for the client\u2019s environment?
|
|
447
|
+
4. Is it maintainable long-term?
|
|
448
|
+
`,
|
|
449
|
+
},
|
|
450
|
+
{
|
|
451
|
+
path: "content/methodology/frameworks.md",
|
|
452
|
+
content: (_ctx: TemplateContext) => `---
|
|
453
|
+
title: Frameworks
|
|
454
|
+
description: Assessment frameworks and scoring models
|
|
455
|
+
---
|
|
456
|
+
|
|
457
|
+
# Frameworks
|
|
458
|
+
|
|
459
|
+
<!-- \u2190 CUSTOMIZE: Replace with your assessment frameworks -->
|
|
460
|
+
|
|
461
|
+
## Maturity Model
|
|
462
|
+
|
|
463
|
+
Use maturity models to assess client capabilities across dimensions.
|
|
464
|
+
|
|
465
|
+
| Level | Label | Description |
|
|
466
|
+
|-------|-------|-------------|
|
|
467
|
+
| 1 | Initial | Ad hoc, undocumented, person-dependent |
|
|
468
|
+
| 2 | Developing | Some documentation, inconsistent execution |
|
|
469
|
+
| 3 | Defined | Documented processes, consistent execution |
|
|
470
|
+
| 4 | Managed | Measured, controlled, data-driven improvement |
|
|
471
|
+
| 5 | Optimized | Continuous improvement, industry-leading |
|
|
472
|
+
|
|
473
|
+
## Scoring Template
|
|
474
|
+
|
|
475
|
+
| Dimension | Current Level | Target Level | Gap | Priority |
|
|
476
|
+
|-----------|--------------|-------------|-----|----------|
|
|
477
|
+
| <!-- dimension --> | <!-- 1\u20135 --> | <!-- 1\u20135 --> | <!-- delta --> | High / Medium / Low |
|
|
478
|
+
|
|
479
|
+
## Framework Selection
|
|
480
|
+
|
|
481
|
+
| Framework | Best For | Limitations |
|
|
482
|
+
|-----------|---------|-------------|
|
|
483
|
+
| Maturity Model | Capability assessment | Can oversimplify |
|
|
484
|
+
| SWOT | Strategic context | Subjective |
|
|
485
|
+
| Risk Matrix | Risk assessment | Requires calibration |
|
|
486
|
+
| Weighted Scoring | Vendor evaluation | Criteria selection bias |
|
|
487
|
+
|
|
488
|
+
## Custom Frameworks
|
|
489
|
+
|
|
490
|
+
Document engagement-specific frameworks in the relevant [Case Study](/content/case-studies/).
|
|
491
|
+
`,
|
|
492
|
+
},
|
|
493
|
+
{
|
|
494
|
+
path: "content/methodology/decisions/index.md",
|
|
495
|
+
content: (_ctx: TemplateContext) => `---
|
|
496
|
+
title: Methodology Decisions
|
|
497
|
+
description: Decision records for methodology and delivery approach
|
|
498
|
+
---
|
|
499
|
+
|
|
500
|
+
# Methodology Decisions
|
|
501
|
+
|
|
502
|
+
<!-- \u2190 CUSTOMIZE: Record decisions about how you deliver services -->
|
|
503
|
+
|
|
504
|
+
| ID | Decision | Date | Status |
|
|
505
|
+
|----|----------|------|--------|
|
|
506
|
+
| MDR-001 | <!-- decision title --> | <!-- date --> | Proposed / Accepted / Superseded |
|
|
507
|
+
|
|
508
|
+
## When to Record a Decision
|
|
509
|
+
|
|
510
|
+
A methodology decision is worth recording when:
|
|
511
|
+
- It changes how we deliver services
|
|
512
|
+
- It affects client experience or deliverable quality
|
|
513
|
+
- Multiple valid approaches were considered
|
|
514
|
+
- Future team members will ask \u201cwhy do we do it this way?\u201d
|
|
515
|
+
|
|
516
|
+
## Using the Template
|
|
517
|
+
|
|
518
|
+
Use the [MDR Template](./mdr-template) for each decision.
|
|
519
|
+
`,
|
|
520
|
+
},
|
|
521
|
+
{
|
|
522
|
+
path: "content/methodology/decisions/mdr-template.md",
|
|
523
|
+
content: (_ctx: TemplateContext) => `---
|
|
524
|
+
title: "MDR-000: Decision Template"
|
|
525
|
+
description: Template for methodology decision records
|
|
526
|
+
---
|
|
527
|
+
|
|
528
|
+
# MDR-000: [Decision Title]
|
|
529
|
+
|
|
530
|
+
## Status
|
|
531
|
+
|
|
532
|
+
Proposed | Accepted | Deprecated | Superseded by [MDR-XXX]
|
|
533
|
+
|
|
534
|
+
## Context
|
|
535
|
+
|
|
536
|
+
<!-- What prompted this decision about our methodology?
|
|
537
|
+
What forces are at play \u2014 client feedback, delivery challenges, market changes? -->
|
|
538
|
+
|
|
539
|
+
## Options Considered
|
|
540
|
+
|
|
541
|
+
### Option A: [Name]
|
|
542
|
+
|
|
543
|
+
- **Pros**: ...
|
|
544
|
+
- **Cons**: ...
|
|
545
|
+
|
|
546
|
+
### Option B: [Name]
|
|
547
|
+
|
|
548
|
+
- **Pros**: ...
|
|
549
|
+
- **Cons**: ...
|
|
550
|
+
|
|
551
|
+
## Decision
|
|
552
|
+
|
|
553
|
+
<!-- What was decided and why. Be specific about the change to methodology. -->
|
|
554
|
+
|
|
555
|
+
## Consequences
|
|
556
|
+
|
|
557
|
+
### Positive
|
|
558
|
+
|
|
559
|
+
- <!-- benefit to delivery quality, client experience, team efficiency -->
|
|
560
|
+
|
|
561
|
+
### Negative
|
|
562
|
+
|
|
563
|
+
- <!-- trade-off, additional overhead, training needed -->
|
|
564
|
+
|
|
565
|
+
### Risks
|
|
566
|
+
|
|
567
|
+
- <!-- risk and mitigation -->
|
|
568
|
+
`,
|
|
569
|
+
},
|
|
570
|
+
// ---------------------------------------------------------------
|
|
571
|
+
// Delivery section
|
|
572
|
+
// ---------------------------------------------------------------
|
|
573
|
+
{
|
|
574
|
+
path: "content/delivery/engagement-lifecycle.md",
|
|
575
|
+
content: (ctx: TemplateContext) => `---
|
|
576
|
+
title: Engagement Lifecycle
|
|
577
|
+
description: End-to-end engagement flow for ${ctx.branding.brandName}
|
|
578
|
+
---
|
|
579
|
+
|
|
580
|
+
# Engagement Lifecycle
|
|
581
|
+
|
|
582
|
+
<!-- \u2190 CUSTOMIZE: Replace with your engagement lifecycle -->
|
|
583
|
+
|
|
584
|
+
## Overview
|
|
585
|
+
|
|
586
|
+
Every engagement follows a lifecycle from initial contact to close-out.
|
|
587
|
+
|
|
588
|
+
\`\`\`
|
|
589
|
+
Qualify \u2192 Scope \u2192 Kickoff \u2192 Deliver \u2192 Review \u2192 Close
|
|
590
|
+
\`\`\`
|
|
591
|
+
|
|
592
|
+
## Stages
|
|
593
|
+
|
|
594
|
+
### 1. Qualify
|
|
595
|
+
|
|
596
|
+
Determine if the engagement is a good fit.
|
|
597
|
+
|
|
598
|
+
- Client need aligns with our offerings
|
|
599
|
+
- We have capacity and expertise
|
|
600
|
+
- Commercial terms are viable
|
|
601
|
+
- **Gate**: Qualify decision (proceed / decline / defer)
|
|
602
|
+
|
|
603
|
+
### 2. Scope
|
|
604
|
+
|
|
605
|
+
Define what we\u2019ll deliver and how.
|
|
606
|
+
|
|
607
|
+
- Discovery call with stakeholders
|
|
608
|
+
- Scope document drafted and approved
|
|
609
|
+
- Timeline and milestones agreed
|
|
610
|
+
- **Gate**: Scope sign-off
|
|
611
|
+
|
|
612
|
+
### 3. Kickoff
|
|
613
|
+
|
|
614
|
+
Mobilize the team and align with the client.
|
|
615
|
+
|
|
616
|
+
- Client onboarding completed
|
|
617
|
+
- Team introductions
|
|
618
|
+
- Working agreements established
|
|
619
|
+
- Access and logistics confirmed
|
|
620
|
+
- **Gate**: Kickoff checklist complete
|
|
621
|
+
|
|
622
|
+
### 4. Deliver
|
|
623
|
+
|
|
624
|
+
Execute the engagement methodology.
|
|
625
|
+
|
|
626
|
+
- Phase execution per [Methodology](/content/methodology/phases)
|
|
627
|
+
- Regular check-ins with client
|
|
628
|
+
- Quality gates at each milestone
|
|
629
|
+
- **Gate**: Deliverable acceptance at each milestone
|
|
630
|
+
|
|
631
|
+
### 5. Review
|
|
632
|
+
|
|
633
|
+
Assess outcomes and gather feedback.
|
|
634
|
+
|
|
635
|
+
- Deliverables accepted by client
|
|
636
|
+
- Client satisfaction survey
|
|
637
|
+
- Internal retrospective
|
|
638
|
+
- Lessons learned captured
|
|
639
|
+
- **Gate**: Review complete
|
|
640
|
+
|
|
641
|
+
### 6. Close
|
|
642
|
+
|
|
643
|
+
Formally end the engagement.
|
|
644
|
+
|
|
645
|
+
- Final invoice processed
|
|
646
|
+
- Knowledge transfer complete
|
|
647
|
+
- Case study drafted (if approved)
|
|
648
|
+
- Follow-up opportunities identified
|
|
649
|
+
- **Gate**: Engagement closed
|
|
650
|
+
|
|
651
|
+
## Related
|
|
652
|
+
|
|
653
|
+
- [Client Onboarding](/content/delivery/client-onboarding) \u2014 kickoff prerequisites
|
|
654
|
+
- [Quality Gates](/content/delivery/quality-gates) \u2014 checkpoints throughout delivery
|
|
655
|
+
`,
|
|
656
|
+
},
|
|
657
|
+
{
|
|
658
|
+
path: "content/delivery/client-onboarding.md",
|
|
659
|
+
content: (_ctx: TemplateContext) => `---
|
|
660
|
+
title: Client Onboarding
|
|
661
|
+
description: Client prerequisites, setup, and kickoff
|
|
662
|
+
---
|
|
663
|
+
|
|
664
|
+
# Client Onboarding
|
|
665
|
+
|
|
666
|
+
<!-- \u2190 CUSTOMIZE: Replace with your onboarding process -->
|
|
667
|
+
|
|
668
|
+
## Pre-Engagement Checklist
|
|
669
|
+
|
|
670
|
+
- [ ] Scope document signed
|
|
671
|
+
- [ ] Commercial terms agreed
|
|
672
|
+
- [ ] Primary client contact identified
|
|
673
|
+
- [ ] Stakeholder list confirmed
|
|
674
|
+
- [ ] NDA and legal requirements met
|
|
675
|
+
|
|
676
|
+
## Access & Logistics
|
|
677
|
+
|
|
678
|
+
- [ ] Meeting cadence established (e.g., weekly check-in)
|
|
679
|
+
- [ ] Communication channel set up (email, Slack, Teams)
|
|
680
|
+
- [ ] Document sharing established (shared drive, portal)
|
|
681
|
+
- [ ] System access provisioned (if needed)
|
|
682
|
+
- [ ] Travel logistics confirmed (if on-site)
|
|
683
|
+
|
|
684
|
+
## Kickoff Meeting Agenda
|
|
685
|
+
|
|
686
|
+
1. Introductions \u2014 team members and roles
|
|
687
|
+
2. Engagement overview \u2014 objectives, scope, timeline
|
|
688
|
+
3. Working agreements \u2014 communication, escalation, decisions
|
|
689
|
+
4. Logistics \u2014 schedules, access, tools
|
|
690
|
+
5. Questions and next steps
|
|
691
|
+
|
|
692
|
+
## Working Agreements
|
|
693
|
+
|
|
694
|
+
| Topic | Agreement |
|
|
695
|
+
|-------|-----------|
|
|
696
|
+
| Check-in frequency | <!-- e.g., weekly --> |
|
|
697
|
+
| Status reporting | <!-- e.g., written update every Friday --> |
|
|
698
|
+
| Decision authority | <!-- who can approve scope changes --> |
|
|
699
|
+
| Escalation path | <!-- primary \u2192 engagement lead \u2192 partner --> |
|
|
700
|
+
| Deliverable review | <!-- turnaround time for client feedback --> |
|
|
701
|
+
|
|
702
|
+
## Onboarding for the Delivery Team
|
|
703
|
+
|
|
704
|
+
1. Read the scope document
|
|
705
|
+
2. Review relevant [Vertical](/content/verticals/overview) context
|
|
706
|
+
3. Check [Methodology Phases](/content/methodology/phases) for engagement type
|
|
707
|
+
4. Familiarize with deliverable templates in [Delivery Templates](/content/delivery/templates/)
|
|
708
|
+
`,
|
|
709
|
+
},
|
|
710
|
+
{
|
|
711
|
+
path: "content/delivery/quality-gates.md",
|
|
712
|
+
content: (_ctx: TemplateContext) => `---
|
|
713
|
+
title: Quality Gates
|
|
714
|
+
description: Quality checkpoints throughout delivery
|
|
715
|
+
---
|
|
716
|
+
|
|
717
|
+
# Quality Gates
|
|
718
|
+
|
|
719
|
+
<!-- \u2190 CUSTOMIZE: Replace with your quality checkpoints -->
|
|
720
|
+
|
|
721
|
+
## Purpose
|
|
722
|
+
|
|
723
|
+
Quality gates are checkpoints that ensure deliverable quality and client alignment before proceeding to the next phase.
|
|
724
|
+
|
|
725
|
+
## Gate Definitions
|
|
726
|
+
|
|
727
|
+
### G1: Scope Approval
|
|
728
|
+
|
|
729
|
+
**When**: Before engagement begins
|
|
730
|
+
**Criteria**:
|
|
731
|
+
- [ ] Scope document complete and specific
|
|
732
|
+
- [ ] Client has reviewed and signed
|
|
733
|
+
- [ ] Team assigned and briefed
|
|
734
|
+
- [ ] Timeline realistic given scope
|
|
735
|
+
|
|
736
|
+
### G2: Discovery Complete
|
|
737
|
+
|
|
738
|
+
**When**: End of Explore phase
|
|
739
|
+
**Criteria**:
|
|
740
|
+
- [ ] All planned interviews completed
|
|
741
|
+
- [ ] Data collection finished
|
|
742
|
+
- [ ] Findings documented
|
|
743
|
+
- [ ] No critical gaps in understanding
|
|
744
|
+
|
|
745
|
+
### G3: Analysis Reviewed
|
|
746
|
+
|
|
747
|
+
**When**: Before Synthesize phase
|
|
748
|
+
**Criteria**:
|
|
749
|
+
- [ ] Gap analysis complete
|
|
750
|
+
- [ ] Findings validated with client
|
|
751
|
+
- [ ] No surprises \u2014 client aware of emerging themes
|
|
752
|
+
- [ ] Ready to develop recommendations
|
|
753
|
+
|
|
754
|
+
### G4: Deliverable Review
|
|
755
|
+
|
|
756
|
+
**When**: Before final delivery to client
|
|
757
|
+
**Criteria**:
|
|
758
|
+
- [ ] Internal peer review completed
|
|
759
|
+
- [ ] Deliverables match scope commitments
|
|
760
|
+
- [ ] Recommendations are actionable and prioritized
|
|
761
|
+
- [ ] Presentation materials ready
|
|
762
|
+
|
|
763
|
+
### G5: Client Acceptance
|
|
764
|
+
|
|
765
|
+
**When**: After delivery presentation
|
|
766
|
+
**Criteria**:
|
|
767
|
+
- [ ] Client has received all deliverables
|
|
768
|
+
- [ ] Questions addressed
|
|
769
|
+
- [ ] Formal acceptance received
|
|
770
|
+
- [ ] Follow-up actions documented
|
|
771
|
+
|
|
772
|
+
## Gate Process
|
|
773
|
+
|
|
774
|
+
1. Engagement lead prepares gate checklist
|
|
775
|
+
2. Peer reviewer validates criteria
|
|
776
|
+
3. Gate decision: **Pass** / **Conditional pass** / **Hold**
|
|
777
|
+
4. Document outcome and any conditions
|
|
778
|
+
`,
|
|
779
|
+
},
|
|
780
|
+
{
|
|
781
|
+
path: "content/delivery/templates/index.md",
|
|
782
|
+
content: (_ctx: TemplateContext) => `---
|
|
783
|
+
title: Deliverable Templates
|
|
784
|
+
description: Report shells and deliverable formats
|
|
785
|
+
---
|
|
786
|
+
|
|
787
|
+
# Deliverable Templates
|
|
788
|
+
|
|
789
|
+
<!-- \u2190 CUSTOMIZE: Add your deliverable templates -->
|
|
790
|
+
|
|
791
|
+
## Available Templates
|
|
792
|
+
|
|
793
|
+
| Template | Used For | Format |
|
|
794
|
+
|----------|---------|--------|
|
|
795
|
+
| Assessment Report | Assessment engagements | Document |
|
|
796
|
+
| Gap Analysis Matrix | All engagements | Spreadsheet |
|
|
797
|
+
| Roadmap | Assessment, advisory | Document + visual |
|
|
798
|
+
| Status Update | All engagements | Email / document |
|
|
799
|
+
| Final Presentation | All engagements | Slides |
|
|
800
|
+
|
|
801
|
+
## Template Conventions
|
|
802
|
+
|
|
803
|
+
- Use consistent branding (client or our brand as appropriate)
|
|
804
|
+
- Include document metadata: version, date, author, status
|
|
805
|
+
- Mark sections as Draft / Review / Final
|
|
806
|
+
- Store completed deliverables in the engagement repository
|
|
807
|
+
|
|
808
|
+
## Creating a New Template
|
|
809
|
+
|
|
810
|
+
1. Create a file in \`content/delivery/templates/\`
|
|
811
|
+
2. Document: purpose, audience, structure, examples
|
|
812
|
+
3. Update this index table
|
|
813
|
+
4. Link from relevant [Offering](/content/offerings/overview)
|
|
814
|
+
`,
|
|
815
|
+
},
|
|
816
|
+
// ---------------------------------------------------------------
|
|
817
|
+
// Verticals section
|
|
818
|
+
// ---------------------------------------------------------------
|
|
819
|
+
{
|
|
820
|
+
path: "content/verticals/overview.md",
|
|
821
|
+
content: (_ctx: TemplateContext) => `---
|
|
822
|
+
title: Verticals Overview
|
|
823
|
+
description: Industry context for client engagements
|
|
824
|
+
---
|
|
825
|
+
|
|
826
|
+
# Verticals
|
|
827
|
+
|
|
828
|
+
<!-- \u2190 CUSTOMIZE: Document industry verticals where you deliver services -->
|
|
829
|
+
|
|
830
|
+
## Purpose
|
|
831
|
+
|
|
832
|
+
Vertical documentation captures **industry-specific context** that shapes how we scope, deliver, and advise clients. Understanding the client\u2019s industry is essential for credible, relevant service delivery.
|
|
833
|
+
|
|
834
|
+
## Documented Verticals
|
|
835
|
+
|
|
836
|
+
| Vertical | Key Characteristics | Our Experience |
|
|
837
|
+
|----------|-------------------|----------------|
|
|
838
|
+
| <!-- industry --> | <!-- what makes it distinct --> | <!-- our track record --> |
|
|
839
|
+
|
|
840
|
+
## What to Capture Per Vertical
|
|
841
|
+
|
|
842
|
+
### Regulatory Environment
|
|
843
|
+
|
|
844
|
+
Regulations, compliance requirements, certifications, and reporting obligations that affect how clients operate.
|
|
845
|
+
|
|
846
|
+
### Industry Terminology
|
|
847
|
+
|
|
848
|
+
Domain-specific terms that differ from general usage. Essential for credible client communication.
|
|
849
|
+
|
|
850
|
+
### Common Challenges
|
|
851
|
+
|
|
852
|
+
Recurring problems and patterns we see across clients in this vertical.
|
|
853
|
+
|
|
854
|
+
### Competitive Landscape
|
|
855
|
+
|
|
856
|
+
Key players, industry trends, and market dynamics that inform our advisory.
|
|
857
|
+
|
|
858
|
+
## Adding a Vertical
|
|
859
|
+
|
|
860
|
+
1. Create a file in \`content/verticals/\`:
|
|
861
|
+
\`\`\`
|
|
862
|
+
content/verticals/healthcare.md
|
|
863
|
+
\`\`\`
|
|
864
|
+
2. Include: regulatory environment, terminology, common challenges, competitive landscape
|
|
865
|
+
3. Update this overview table
|
|
866
|
+
4. Link from relevant [Case Studies](/content/case-studies/)
|
|
867
|
+
`,
|
|
868
|
+
},
|
|
869
|
+
// ---------------------------------------------------------------
|
|
870
|
+
// Case Studies section
|
|
871
|
+
// ---------------------------------------------------------------
|
|
872
|
+
{
|
|
873
|
+
path: "content/case-studies/index.md",
|
|
874
|
+
content: (_ctx: TemplateContext) => `---
|
|
875
|
+
title: Case Studies
|
|
876
|
+
description: Past engagements and proven results
|
|
877
|
+
---
|
|
878
|
+
|
|
879
|
+
# Case Studies
|
|
880
|
+
|
|
881
|
+
<!-- \u2190 CUSTOMIZE: Add case studies as engagements complete -->
|
|
882
|
+
|
|
883
|
+
| Case Study | Vertical | Service | Outcome |
|
|
884
|
+
|-----------|----------|---------|---------|
|
|
885
|
+
| <!-- title --> | <!-- industry --> | <!-- service type --> | <!-- key result --> |
|
|
886
|
+
|
|
887
|
+
## Why Document Case Studies
|
|
888
|
+
|
|
889
|
+
- Demonstrate capability to prospective clients
|
|
890
|
+
- Capture lessons learned for the team
|
|
891
|
+
- Build institutional knowledge across verticals
|
|
892
|
+
- Support proposals with evidence of past success
|
|
893
|
+
|
|
894
|
+
## Case Study Template
|
|
895
|
+
|
|
896
|
+
Each case study should include:
|
|
897
|
+
|
|
898
|
+
### Context
|
|
899
|
+
- Client industry and size (anonymized if needed)
|
|
900
|
+
- Problem or opportunity that prompted the engagement
|
|
901
|
+
- Constraints and complexities
|
|
902
|
+
|
|
903
|
+
### Approach
|
|
904
|
+
- Service type and engagement model
|
|
905
|
+
- Methodology phases used
|
|
906
|
+
- Team composition
|
|
907
|
+
- Timeline
|
|
908
|
+
|
|
909
|
+
### Deliverables
|
|
910
|
+
- What we produced
|
|
911
|
+
- Key findings or recommendations
|
|
912
|
+
|
|
913
|
+
### Outcomes
|
|
914
|
+
- Measurable results (quantified where possible)
|
|
915
|
+
- Client feedback
|
|
916
|
+
- Follow-on work (if any)
|
|
917
|
+
|
|
918
|
+
### Lessons Learned
|
|
919
|
+
- What worked well
|
|
920
|
+
- What we\u2019d do differently
|
|
921
|
+
- Insights applicable to future engagements
|
|
922
|
+
|
|
923
|
+
## Anonymization Guidelines
|
|
924
|
+
|
|
925
|
+
- Replace client name with descriptor (e.g., \u201cMid-market healthcare provider\u201d)
|
|
926
|
+
- Remove specific financial figures unless approved
|
|
927
|
+
- Generalize technology names if identifying
|
|
928
|
+
- Get client approval before publishing externally
|
|
929
|
+
`,
|
|
930
|
+
},
|
|
931
|
+
// ---------------------------------------------------------------
|
|
932
|
+
// Reference section
|
|
933
|
+
// ---------------------------------------------------------------
|
|
934
|
+
{
|
|
935
|
+
path: "content/reference/team-expertise.md",
|
|
936
|
+
content: (_ctx: TemplateContext) => `---
|
|
937
|
+
title: Team Expertise
|
|
938
|
+
description: Team capabilities and specializations
|
|
939
|
+
---
|
|
940
|
+
|
|
941
|
+
# Team Expertise
|
|
942
|
+
|
|
943
|
+
<!-- \u2190 CUSTOMIZE: Document your team\u2019s capabilities -->
|
|
944
|
+
|
|
945
|
+
## Capability Matrix
|
|
946
|
+
|
|
947
|
+
| Capability | Team Members | Depth | Verticals |
|
|
948
|
+
|-----------|-------------|-------|-----------|
|
|
949
|
+
| <!-- capability --> | <!-- who --> | Expert / Proficient / Developing | <!-- industries --> |
|
|
950
|
+
|
|
951
|
+
## Specializations
|
|
952
|
+
|
|
953
|
+
### <!-- Specialization Name -->
|
|
954
|
+
|
|
955
|
+
<!-- Description, experience, notable engagements -->
|
|
956
|
+
|
|
957
|
+
## Certifications & Credentials
|
|
958
|
+
|
|
959
|
+
| Person | Certification | Issuer | Expiry |
|
|
960
|
+
|--------|-------------|--------|--------|
|
|
961
|
+
| <!-- name --> | <!-- cert --> | <!-- issuer --> | <!-- date --> |
|
|
962
|
+
|
|
963
|
+
## Capacity Planning
|
|
964
|
+
|
|
965
|
+
| Team Member | Current Engagement | Availability |
|
|
966
|
+
|------------|-------------------|-------------|
|
|
967
|
+
| <!-- name --> | <!-- engagement --> | <!-- date available --> |
|
|
968
|
+
|
|
969
|
+
## Professional Development
|
|
970
|
+
|
|
971
|
+
- Areas where the team is investing in new capabilities
|
|
972
|
+
- Training in progress or planned
|
|
973
|
+
- Conference participation
|
|
974
|
+
`,
|
|
975
|
+
},
|
|
976
|
+
{
|
|
977
|
+
path: "content/reference/pricing-models.md",
|
|
978
|
+
content: (_ctx: TemplateContext) => `---
|
|
979
|
+
title: Pricing Models
|
|
980
|
+
description: Engagement pricing structures
|
|
981
|
+
---
|
|
982
|
+
|
|
983
|
+
# Pricing Models
|
|
984
|
+
|
|
985
|
+
<!-- \u2190 CUSTOMIZE: Document your pricing approach -->
|
|
986
|
+
|
|
987
|
+
## Engagement Types
|
|
988
|
+
|
|
989
|
+
### Fixed-Price
|
|
990
|
+
|
|
991
|
+
| Component | Description |
|
|
992
|
+
|-----------|-------------|
|
|
993
|
+
| Basis | Defined scope and deliverables |
|
|
994
|
+
| Risk | Provider absorbs scope risk |
|
|
995
|
+
| Best for | Assessments, well-defined projects |
|
|
996
|
+
| Client benefit | Budget certainty |
|
|
997
|
+
|
|
998
|
+
### Time & Materials
|
|
999
|
+
|
|
1000
|
+
| Component | Description |
|
|
1001
|
+
|-----------|-------------|
|
|
1002
|
+
| Basis | Hourly/daily rates for actual effort |
|
|
1003
|
+
| Risk | Client absorbs scope variability |
|
|
1004
|
+
| Best for | Advisory, evolving requirements |
|
|
1005
|
+
| Client benefit | Flexibility |
|
|
1006
|
+
|
|
1007
|
+
### Milestone-Based
|
|
1008
|
+
|
|
1009
|
+
| Component | Description |
|
|
1010
|
+
|-----------|-------------|
|
|
1011
|
+
| Basis | Payments tied to deliverable acceptance |
|
|
1012
|
+
| Risk | Shared between client and provider |
|
|
1013
|
+
| Best for | Implementation engagements |
|
|
1014
|
+
| Client benefit | Payment aligned with value delivered |
|
|
1015
|
+
|
|
1016
|
+
## Rate Structure
|
|
1017
|
+
|
|
1018
|
+
<!-- \u2190 CUSTOMIZE: Define your rate tiers (internal reference) -->
|
|
1019
|
+
|
|
1020
|
+
| Role | Rate Range | Notes |
|
|
1021
|
+
|------|-----------|-------|
|
|
1022
|
+
| <!-- role --> | <!-- range --> | <!-- context --> |
|
|
1023
|
+
|
|
1024
|
+
## Discount & Adjustment Policies
|
|
1025
|
+
|
|
1026
|
+
<!-- Volume discounts, non-profit rates, retainer discounts, etc. -->
|
|
1027
|
+
|
|
1028
|
+
## Proposal Templates
|
|
1029
|
+
|
|
1030
|
+
Link to standard proposal templates and commercial terms.
|
|
1031
|
+
`,
|
|
1032
|
+
},
|
|
1033
|
+
{
|
|
1034
|
+
path: "content/reference/contacts/directory.md",
|
|
1035
|
+
content: (ctx: TemplateContext) => `---
|
|
1036
|
+
title: Contact Directory
|
|
1037
|
+
description: Team contacts and escalation for ${ctx.branding.brandName}
|
|
1038
|
+
---
|
|
1039
|
+
|
|
1040
|
+
# Contact Directory
|
|
1041
|
+
|
|
1042
|
+
<!-- \u2190 CUSTOMIZE: Add your team and partner contacts -->
|
|
1043
|
+
|
|
1044
|
+
## Delivery Team
|
|
1045
|
+
|
|
1046
|
+
| Role | Contact | Responsibility |
|
|
1047
|
+
|------|---------|----------------|
|
|
1048
|
+
| Practice Lead | <!-- name/email --> | Service strategy, client relationships |
|
|
1049
|
+
| Engagement Lead | <!-- name/email --> | Delivery oversight, quality assurance |
|
|
1050
|
+
| Senior Consultant | <!-- name/email --> | Analysis, recommendations |
|
|
1051
|
+
| Analyst | <!-- name/email --> | Research, data collection |
|
|
1052
|
+
|
|
1053
|
+
## Partners & Subcontractors
|
|
1054
|
+
|
|
1055
|
+
| Partner | Specialty | Contact |
|
|
1056
|
+
|---------|----------|---------|
|
|
1057
|
+
| <!-- partner --> | <!-- what they provide --> | <!-- contact --> |
|
|
1058
|
+
|
|
1059
|
+
## Escalation Path
|
|
1060
|
+
|
|
1061
|
+
1. **Engagement Lead** \u2014 day-to-day delivery issues
|
|
1062
|
+
2. **Practice Lead** \u2014 scope changes, client concerns
|
|
1063
|
+
3. **Managing Partner** \u2014 commercial disputes, strategic issues
|
|
1064
|
+
|
|
1065
|
+
## Client Communication
|
|
1066
|
+
|
|
1067
|
+
| Channel | Purpose | Response Time |
|
|
1068
|
+
|---------|---------|--------------|
|
|
1069
|
+
| Email | Formal communication, deliverables | 24 hours |
|
|
1070
|
+
| Slack/Teams | Day-to-day coordination | 4 hours |
|
|
1071
|
+
| Phone | Urgent issues | Immediate |
|
|
1072
|
+
`,
|
|
1073
|
+
},
|
|
1074
|
+
// ---------------------------------------------------------------
|
|
1075
|
+
// CUSTOMIZING.md
|
|
1076
|
+
// ---------------------------------------------------------------
|
|
1077
|
+
{
|
|
1078
|
+
path: "CUSTOMIZING.md",
|
|
1079
|
+
content: (ctx: TemplateContext) => `---
|
|
1080
|
+
template: servicebook
|
|
1081
|
+
template_version: 1
|
|
1082
|
+
created: ${new Date().toISOString().split("T")[0]}
|
|
1083
|
+
---
|
|
1084
|
+
|
|
1085
|
+
# Customizing ${ctx.branding.siteName}
|
|
1086
|
+
|
|
1087
|
+
This guide helps you (and AI assistants) understand how to customize this servicebook.
|
|
1088
|
+
|
|
1089
|
+
## Site Structure
|
|
1090
|
+
|
|
1091
|
+
\`\`\`
|
|
1092
|
+
${ctx.name}/
|
|
1093
|
+
\u251c\u2500\u2500 site.yaml # Site configuration (sections, branding)
|
|
1094
|
+
\u251c\u2500\u2500 theme.yaml # Theme customization (create if needed)
|
|
1095
|
+
\u251c\u2500\u2500 index.md # Home page with service catalog summary
|
|
1096
|
+
\u251c\u2500\u2500 CUSTOMIZING.md # This file
|
|
1097
|
+
\u251c\u2500\u2500 content/
|
|
1098
|
+
\u2502 \u251c\u2500\u2500 offerings/ # Service definitions
|
|
1099
|
+
\u2502 \u2502 \u2514\u2500\u2500 assess/ # Example: assessment service
|
|
1100
|
+
\u2502 \u251c\u2500\u2500 methodology/ # How we deliver
|
|
1101
|
+
\u2502 \u2502 \u2514\u2500\u2500 decisions/ # Methodology decision records
|
|
1102
|
+
\u2502 \u251c\u2500\u2500 delivery/ # Engagement operations
|
|
1103
|
+
\u2502 \u2502 \u2514\u2500\u2500 templates/ # Deliverable templates
|
|
1104
|
+
\u2502 \u251c\u2500\u2500 verticals/ # Industry context
|
|
1105
|
+
\u2502 \u251c\u2500\u2500 case-studies/ # Past engagements
|
|
1106
|
+
\u2502 \u2514\u2500\u2500 reference/ # Supporting materials
|
|
1107
|
+
\u2502 \u2514\u2500\u2500 contacts/ # Team contacts, escalation
|
|
1108
|
+
\u2514\u2500\u2500 assets/
|
|
1109
|
+
\u2514\u2500\u2500 brand/ # Logo, favicon
|
|
1110
|
+
\`\`\`
|
|
1111
|
+
|
|
1112
|
+
## Configuration Files
|
|
1113
|
+
|
|
1114
|
+
### site.yaml - Site Configuration
|
|
1115
|
+
|
|
1116
|
+
\`\`\`yaml
|
|
1117
|
+
title: "${ctx.branding.siteName}"
|
|
1118
|
+
|
|
1119
|
+
brand:
|
|
1120
|
+
name: "${ctx.branding.brandName}" # Shown in header
|
|
1121
|
+
url: "/" # Logo link destination
|
|
1122
|
+
|
|
1123
|
+
sections:
|
|
1124
|
+
- name: "Offerings"
|
|
1125
|
+
path: "content/offerings"
|
|
1126
|
+
# Add or modify sections here
|
|
1127
|
+
\`\`\`
|
|
1128
|
+
|
|
1129
|
+
### theme.yaml - Visual Customization (optional)
|
|
1130
|
+
|
|
1131
|
+
Create \`theme.yaml\` to customize colors and typography:
|
|
1132
|
+
|
|
1133
|
+
\`\`\`yaml
|
|
1134
|
+
colors:
|
|
1135
|
+
primary: "#2563eb"
|
|
1136
|
+
background: "#ffffff"
|
|
1137
|
+
text: "#1f2937"
|
|
1138
|
+
|
|
1139
|
+
footer:
|
|
1140
|
+
text: "\u00a9 ${ctx.year} ${ctx.branding.brandName}"
|
|
1141
|
+
\`\`\`
|
|
1142
|
+
|
|
1143
|
+
## Adding Content
|
|
1144
|
+
|
|
1145
|
+
### New Service Offering
|
|
1146
|
+
|
|
1147
|
+
1. Create a folder in \`content/offerings/\`:
|
|
1148
|
+
\`\`\`
|
|
1149
|
+
content/offerings/my-service/overview.md
|
|
1150
|
+
content/offerings/my-service/deliverables.md
|
|
1151
|
+
content/offerings/my-service/scoping.md
|
|
1152
|
+
\`\`\`
|
|
1153
|
+
2. Include: client problem, deliverables, scoping criteria, timeline
|
|
1154
|
+
3. Update the service catalog in \`content/offerings/overview.md\`
|
|
1155
|
+
|
|
1156
|
+
### Documenting a Methodology Change
|
|
1157
|
+
|
|
1158
|
+
1. Copy the [MDR Template](/content/methodology/decisions/mdr-template) to a new file:
|
|
1159
|
+
\`\`\`
|
|
1160
|
+
content/methodology/decisions/mdr-001-my-decision.md
|
|
1161
|
+
\`\`\`
|
|
1162
|
+
2. Fill in: context, options, decision, consequences
|
|
1163
|
+
3. Update the index in \`content/methodology/decisions/index.md\`
|
|
1164
|
+
|
|
1165
|
+
### Adding a Case Study
|
|
1166
|
+
|
|
1167
|
+
1. Create a file in \`content/case-studies/\`:
|
|
1168
|
+
\`\`\`
|
|
1169
|
+
content/case-studies/healthcare-assessment-2025.md
|
|
1170
|
+
\`\`\`
|
|
1171
|
+
2. Follow the template: Context, Approach, Deliverables, Outcomes, Lessons Learned
|
|
1172
|
+
3. Anonymize per guidelines in the [Case Studies index](/content/case-studies/)
|
|
1173
|
+
4. Update the case studies index table
|
|
1174
|
+
|
|
1175
|
+
### Adding a Vertical
|
|
1176
|
+
|
|
1177
|
+
1. Create a file in \`content/verticals/\`:
|
|
1178
|
+
\`\`\`
|
|
1179
|
+
content/verticals/healthcare.md
|
|
1180
|
+
\`\`\`
|
|
1181
|
+
2. Include: regulatory environment, terminology, common challenges, competitive landscape
|
|
1182
|
+
3. Update the verticals overview table
|
|
1183
|
+
|
|
1184
|
+
### New Section
|
|
1185
|
+
|
|
1186
|
+
1. Create folder: \`content/newsection/\`
|
|
1187
|
+
2. Add to \`site.yaml\`:
|
|
1188
|
+
\`\`\`yaml
|
|
1189
|
+
sections:
|
|
1190
|
+
- name: "New Section"
|
|
1191
|
+
path: "content/newsection"
|
|
1192
|
+
\`\`\`
|
|
1193
|
+
3. Add at least one markdown file
|
|
1194
|
+
|
|
1195
|
+
## Document Conventions
|
|
1196
|
+
|
|
1197
|
+
### Offerings (services, deliverables, scoping)
|
|
1198
|
+
|
|
1199
|
+
- State the client problem before the solution
|
|
1200
|
+
- Define deliverables with format, content, and audience
|
|
1201
|
+
- Include scoping criteria so engagements are sized consistently
|
|
1202
|
+
|
|
1203
|
+
### Methodology (phases, tools, frameworks)
|
|
1204
|
+
|
|
1205
|
+
- Document phases with inputs, activities, and outputs
|
|
1206
|
+
- Tools should include purpose and when they\u2019re used
|
|
1207
|
+
- Frameworks need clear scoring criteria and limitations
|
|
1208
|
+
|
|
1209
|
+
### Delivery (lifecycle, quality gates)
|
|
1210
|
+
|
|
1211
|
+
- Engagement lifecycle needs gates between each stage
|
|
1212
|
+
- Quality gates need specific, checkable criteria
|
|
1213
|
+
- Templates should be ready to use, not just described
|
|
1214
|
+
|
|
1215
|
+
### Case Studies
|
|
1216
|
+
|
|
1217
|
+
- Always anonymize unless client has approved attribution
|
|
1218
|
+
- Quantify outcomes where possible
|
|
1219
|
+
- Include lessons learned \u2014 what you\u2019d do differently
|
|
1220
|
+
|
|
1221
|
+
## Linking and References
|
|
1222
|
+
|
|
1223
|
+
### Internal Links
|
|
1224
|
+
|
|
1225
|
+
\`\`\`markdown
|
|
1226
|
+
See [Service Catalog](/content/offerings/overview) for available services.
|
|
1227
|
+
\`\`\`
|
|
1228
|
+
|
|
1229
|
+
### External Links
|
|
1230
|
+
|
|
1231
|
+
\`\`\`markdown
|
|
1232
|
+
See [Industry Report](https://example.com/report).
|
|
1233
|
+
\`\`\`
|
|
1234
|
+
|
|
1235
|
+
## Getting Help
|
|
1236
|
+
|
|
1237
|
+
- [Kitfly Documentation](https://github.com/3leaps/kitfly)
|
|
1238
|
+
- [Markdown Guide](https://www.markdownguide.org/)
|
|
1239
|
+
`,
|
|
1240
|
+
},
|
|
1241
|
+
],
|
|
1242
|
+
};
|