@tekyzinc/gsd-t 2.0.1 → 2.0.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/commands/gsd-t-init.md +13 -6
- package/commands/gsd-t-scan.md +50 -2
- package/package.json +1 -1
package/commands/gsd-t-init.md
CHANGED
|
@@ -73,9 +73,10 @@ Create a starter template:
|
|
|
73
73
|
{Languages, frameworks, services — fill this in}
|
|
74
74
|
|
|
75
75
|
## Documentation
|
|
76
|
-
- Requirements: docs/requirements.md
|
|
77
|
-
- Architecture: docs/architecture.md
|
|
78
|
-
-
|
|
76
|
+
- Requirements: docs/requirements.md
|
|
77
|
+
- Architecture: docs/architecture.md
|
|
78
|
+
- Workflows: docs/workflows.md
|
|
79
|
+
- Infrastructure: docs/infrastructure.md
|
|
79
80
|
|
|
80
81
|
## Conventions
|
|
81
82
|
- {Coding style, naming patterns — fill this in}
|
|
@@ -91,13 +92,19 @@ If `CLAUDE.md` exists but doesn't reference GSD-T, append the GSD-T section.
|
|
|
91
92
|
|
|
92
93
|
## Step 5: Create docs/ if Needed
|
|
93
94
|
|
|
94
|
-
If no `docs/` directory
|
|
95
|
+
If no `docs/` directory, create it with all 4 living document templates.
|
|
96
|
+
For each file, skip if it already exists:
|
|
97
|
+
|
|
95
98
|
```
|
|
96
99
|
docs/
|
|
97
|
-
├── requirements.md —
|
|
98
|
-
|
|
100
|
+
├── requirements.md — Functional, technical, and non-functional requirements
|
|
101
|
+
├── architecture.md — System design, components, data flow, design decisions
|
|
102
|
+
├── workflows.md — User journeys, technical processes, API flows
|
|
103
|
+
└── infrastructure.md — Dev setup, DB commands, cloud provisioning, deployment, credentials
|
|
99
104
|
```
|
|
100
105
|
|
|
106
|
+
These are the living documents that persist across milestones and keep institutional knowledge alive. The `infrastructure.md` is especially important — it captures the exact commands for provisioning cloud resources, setting up databases, managing secrets, and deploying, so this knowledge doesn't get lost between sessions.
|
|
107
|
+
|
|
101
108
|
## Step 6: Map Existing Codebase (if code exists)
|
|
102
109
|
|
|
103
110
|
If there's existing source code:
|
package/commands/gsd-t-scan.md
CHANGED
|
@@ -310,7 +310,55 @@ Estimated effort: {assessment}
|
|
|
310
310
|
Can be scheduled: During next maintenance window
|
|
311
311
|
```
|
|
312
312
|
|
|
313
|
-
## Step 5: Update
|
|
313
|
+
## Step 5: Update Living Documents
|
|
314
|
+
|
|
315
|
+
The scan produces deep analysis in `.gsd-t/scan/`. Now cross-populate findings into the living docs so knowledge persists across milestones.
|
|
316
|
+
|
|
317
|
+
### docs/architecture.md
|
|
318
|
+
Using findings from `.gsd-t/scan/architecture.md`, update or create `docs/architecture.md`:
|
|
319
|
+
- System overview (stack, structure, patterns)
|
|
320
|
+
- Component descriptions with locations and dependencies
|
|
321
|
+
- Data flow (request → handler → service → data layer → response)
|
|
322
|
+
- Data models from schema files or ORM definitions
|
|
323
|
+
- API structure from route definitions
|
|
324
|
+
- External integrations
|
|
325
|
+
- Design decisions found in code comments or configs
|
|
326
|
+
|
|
327
|
+
If the file exists, merge new findings — don't overwrite existing content.
|
|
328
|
+
|
|
329
|
+
### docs/workflows.md
|
|
330
|
+
Using findings from `.gsd-t/scan/business-rules.md`, update or create `docs/workflows.md`:
|
|
331
|
+
- User workflows traced from routes/handlers (registration, login, core features)
|
|
332
|
+
- Technical workflows from cron jobs, queue workers, scheduled tasks
|
|
333
|
+
- API workflows for multi-step operations
|
|
334
|
+
- Integration workflows for external system syncing
|
|
335
|
+
- State machines and approval flows discovered in code
|
|
336
|
+
|
|
337
|
+
### docs/infrastructure.md
|
|
338
|
+
Scan the codebase for operational knowledge and update or create `docs/infrastructure.md`:
|
|
339
|
+
- **Quick Reference commands** from package.json scripts, Makefile, README, CI/CD configs
|
|
340
|
+
- **Local development setup** from README, docker-compose, .env.example
|
|
341
|
+
- **Database commands** from migrations, seeds, ORM config, backup scripts
|
|
342
|
+
- **Cloud provisioning** from Terraform, CloudFormation, Pulumi, or deployment scripts
|
|
343
|
+
- **Credentials and secrets** from .env.example (names only, not values) and secret manager configs
|
|
344
|
+
- **Deployment** from CI/CD configs, Dockerfiles, cloud platform configs
|
|
345
|
+
- **Logging and monitoring** from any logging setup or dashboard configs
|
|
346
|
+
|
|
347
|
+
This is critical — infrastructure knowledge is the most commonly lost between sessions.
|
|
348
|
+
|
|
349
|
+
### docs/requirements.md
|
|
350
|
+
Using all scan findings, update or create `docs/requirements.md`:
|
|
351
|
+
- Functional requirements discovered from routes, handlers, UI components
|
|
352
|
+
- Technical requirements from configs, package.json, runtime settings
|
|
353
|
+
- Non-functional requirements from performance configs, rate limits, caching
|
|
354
|
+
|
|
355
|
+
### For all docs:
|
|
356
|
+
- If the file exists and has real content, **merge** — don't overwrite
|
|
357
|
+
- If the file exists with only placeholder text, **replace** with real findings
|
|
358
|
+
- If the file doesn't exist, **create** it
|
|
359
|
+
- Replace `{Project Name}` and `{Date}` tokens with actual values
|
|
360
|
+
|
|
361
|
+
## Step 6: Update Project State
|
|
314
362
|
|
|
315
363
|
If `.gsd-t/progress.md` exists:
|
|
316
364
|
- Log scan in Decision Log
|
|
@@ -323,7 +371,7 @@ If `.gsd-t/roadmap.md` exists:
|
|
|
323
371
|
If `CLAUDE.md` exists:
|
|
324
372
|
- Suggest updates for any patterns or conventions discovered during scan
|
|
325
373
|
|
|
326
|
-
## Step
|
|
374
|
+
## Step 7: Report to User
|
|
327
375
|
|
|
328
376
|
Present a summary:
|
|
329
377
|
1. Architecture overview (brief)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tekyzinc/gsd-t",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.2",
|
|
4
4
|
"description": "GSD-T: Contract-Driven Development for Claude Code — 27 slash commands with impact analysis, test sync, and milestone archival",
|
|
5
5
|
"author": "Tekyz, Inc.",
|
|
6
6
|
"license": "MIT",
|