@vpxa/aikit 0.1.73 → 0.1.75

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.
Files changed (142) hide show
  1. package/package.json +9 -1
  2. package/packages/cli/dist/index.js +2 -2
  3. package/packages/cli/dist/{init-D_OGLUN1.js → init-CuRXmyD9.js} +4 -4
  4. package/packages/cli/dist/scaffold-WMQ2uQ48.js +2 -0
  5. package/packages/cli/dist/{templates-DJ7EC5vw.js → templates-ArdAVWoY.js} +13 -3
  6. package/packages/cli/dist/user-vbJwa7x2.js +5 -0
  7. package/packages/dashboard/dist/assets/index-C6D-PCp0.js.map +1 -1
  8. package/packages/flows/dist/index.d.ts +29 -0
  9. package/packages/flows/dist/index.js +1 -1
  10. package/packages/server/dist/index.js +1 -1
  11. package/packages/server/dist/{server-B9Mx1aK-.js → server-CVhVH5cT.js} +127 -127
  12. package/packages/tools/dist/index.d.ts +19 -1
  13. package/packages/tools/dist/index.js +39 -39
  14. package/scaffold/dist/adapters/claude-code.mjs +4 -0
  15. package/scaffold/dist/adapters/copilot.mjs +75 -0
  16. package/scaffold/dist/adapters/flows.mjs +1 -0
  17. package/scaffold/dist/adapters/skills.mjs +1 -0
  18. package/scaffold/dist/compiled/flows-data.mjs +1429 -0
  19. package/scaffold/dist/compiled/skills-data.mjs +9951 -0
  20. package/scaffold/dist/definitions/agents.mjs +9 -0
  21. package/scaffold/{definitions → dist/definitions}/bodies.mjs +6 -229
  22. package/scaffold/dist/definitions/exclusions.mjs +1 -0
  23. package/scaffold/dist/definitions/hooks.mjs +1 -0
  24. package/scaffold/dist/definitions/models.mjs +1 -0
  25. package/scaffold/dist/definitions/plugins.mjs +1 -0
  26. package/scaffold/{definitions → dist/definitions}/prompts.mjs +9 -149
  27. package/scaffold/{definitions → dist/definitions}/protocols.mjs +9 -37
  28. package/scaffold/dist/definitions/tools.mjs +1 -0
  29. package/packages/cli/dist/scaffold-CJwkHf-q.js +0 -2
  30. package/packages/cli/dist/user-BEmVW8Tp.js +0 -5
  31. package/scaffold/adapters/claude-code.mjs +0 -73
  32. package/scaffold/adapters/copilot.mjs +0 -292
  33. package/scaffold/definitions/agents.mjs +0 -266
  34. package/scaffold/definitions/hooks.mjs +0 -43
  35. package/scaffold/definitions/models.mjs +0 -84
  36. package/scaffold/definitions/plugins.mjs +0 -147
  37. package/scaffold/definitions/tools.mjs +0 -250
  38. package/scaffold/flows/_epilogue/steps/docs-sync/README.md +0 -120
  39. package/scaffold/flows/aikit-advanced/README.md +0 -70
  40. package/scaffold/flows/aikit-advanced/flow.json +0 -69
  41. package/scaffold/flows/aikit-advanced/steps/design/README.md +0 -178
  42. package/scaffold/flows/aikit-advanced/steps/execute/README.md +0 -145
  43. package/scaffold/flows/aikit-advanced/steps/plan/README.md +0 -122
  44. package/scaffold/flows/aikit-advanced/steps/spec/README.md +0 -121
  45. package/scaffold/flows/aikit-advanced/steps/task/README.md +0 -119
  46. package/scaffold/flows/aikit-advanced/steps/verify/README.md +0 -145
  47. package/scaffold/flows/aikit-basic/README.md +0 -51
  48. package/scaffold/flows/aikit-basic/flow.json +0 -45
  49. package/scaffold/flows/aikit-basic/steps/assess/README.md +0 -109
  50. package/scaffold/flows/aikit-basic/steps/design/README.md +0 -116
  51. package/scaffold/flows/aikit-basic/steps/implement/README.md +0 -131
  52. package/scaffold/flows/aikit-basic/steps/verify/README.md +0 -123
  53. package/scaffold/general/agents/Architect-Reviewer-Alpha.agent.md +0 -132
  54. package/scaffold/general/agents/Architect-Reviewer-Beta.agent.md +0 -132
  55. package/scaffold/general/agents/Code-Reviewer-Alpha.agent.md +0 -112
  56. package/scaffold/general/agents/Code-Reviewer-Beta.agent.md +0 -112
  57. package/scaffold/general/agents/Debugger.agent.md +0 -412
  58. package/scaffold/general/agents/Documenter.agent.md +0 -468
  59. package/scaffold/general/agents/Explorer.agent.md +0 -76
  60. package/scaffold/general/agents/Frontend.agent.md +0 -440
  61. package/scaffold/general/agents/Implementer.agent.md +0 -425
  62. package/scaffold/general/agents/Orchestrator.agent.md +0 -452
  63. package/scaffold/general/agents/Planner.agent.md +0 -481
  64. package/scaffold/general/agents/README.md +0 -57
  65. package/scaffold/general/agents/Refactor.agent.md +0 -435
  66. package/scaffold/general/agents/Researcher-Alpha.agent.md +0 -151
  67. package/scaffold/general/agents/Researcher-Beta.agent.md +0 -152
  68. package/scaffold/general/agents/Researcher-Delta.agent.md +0 -153
  69. package/scaffold/general/agents/Researcher-Gamma.agent.md +0 -152
  70. package/scaffold/general/agents/Security.agent.md +0 -433
  71. package/scaffold/general/agents/_shared/architect-reviewer-base.md +0 -104
  72. package/scaffold/general/agents/_shared/code-agent-base.md +0 -366
  73. package/scaffold/general/agents/_shared/code-reviewer-base.md +0 -87
  74. package/scaffold/general/agents/_shared/decision-protocol.md +0 -27
  75. package/scaffold/general/agents/_shared/forge-protocol.md +0 -90
  76. package/scaffold/general/agents/_shared/researcher-base.md +0 -114
  77. package/scaffold/general/agents/templates/adr-template.md +0 -28
  78. package/scaffold/general/agents/templates/execution-state.md +0 -26
  79. package/scaffold/general/prompts/aikit-ask.prompt.md +0 -13
  80. package/scaffold/general/prompts/aikit-debug.prompt.md +0 -15
  81. package/scaffold/general/prompts/aikit-design.prompt.md +0 -15
  82. package/scaffold/general/prompts/aikit-flow-add.prompt.md +0 -84
  83. package/scaffold/general/prompts/aikit-flow-create.prompt.md +0 -80
  84. package/scaffold/general/prompts/aikit-flow-manage.prompt.md +0 -24
  85. package/scaffold/general/prompts/aikit-implement.prompt.md +0 -17
  86. package/scaffold/general/prompts/aikit-plan.prompt.md +0 -15
  87. package/scaffold/general/prompts/aikit-review.prompt.md +0 -24
  88. package/scaffold/general/skills/adr-skill/SKILL.md +0 -335
  89. package/scaffold/general/skills/adr-skill/assets/templates/adr-madr.md +0 -89
  90. package/scaffold/general/skills/adr-skill/assets/templates/adr-readme.md +0 -20
  91. package/scaffold/general/skills/adr-skill/assets/templates/adr-simple.md +0 -46
  92. package/scaffold/general/skills/adr-skill/references/adr-conventions.md +0 -95
  93. package/scaffold/general/skills/adr-skill/references/examples.md +0 -193
  94. package/scaffold/general/skills/adr-skill/references/review-checklist.md +0 -77
  95. package/scaffold/general/skills/adr-skill/references/template-variants.md +0 -52
  96. package/scaffold/general/skills/adr-skill/scripts/bootstrap_adr.js +0 -259
  97. package/scaffold/general/skills/adr-skill/scripts/new_adr.js +0 -391
  98. package/scaffold/general/skills/adr-skill/scripts/set_adr_status.js +0 -169
  99. package/scaffold/general/skills/aikit/SKILL.md +0 -754
  100. package/scaffold/general/skills/brainstorming/SKILL.md +0 -265
  101. package/scaffold/general/skills/brainstorming/spec-document-reviewer-prompt.md +0 -49
  102. package/scaffold/general/skills/c4-architecture/SKILL.md +0 -389
  103. package/scaffold/general/skills/c4-architecture/references/advanced-patterns.md +0 -552
  104. package/scaffold/general/skills/c4-architecture/references/c4-syntax.md +0 -510
  105. package/scaffold/general/skills/c4-architecture/references/common-mistakes.md +0 -437
  106. package/scaffold/general/skills/c4-architecture/references/html-design-system.md +0 -337
  107. package/scaffold/general/skills/c4-architecture/references/html-template.html +0 -627
  108. package/scaffold/general/skills/docs/SKILL.md +0 -553
  109. package/scaffold/general/skills/docs/references/diataxis-anti-patterns.md +0 -147
  110. package/scaffold/general/skills/docs/references/diataxis-compass.md +0 -123
  111. package/scaffold/general/skills/docs/references/diataxis-quadrants.md +0 -192
  112. package/scaffold/general/skills/docs/references/diataxis-quality.md +0 -76
  113. package/scaffold/general/skills/docs/references/diataxis-templates.md +0 -120
  114. package/scaffold/general/skills/docs/references/flow-artifacts-guide.md +0 -70
  115. package/scaffold/general/skills/docs/references/project-knowledge-gotchas.md +0 -32
  116. package/scaffold/general/skills/docs/references/project-knowledge-templates.md +0 -281
  117. package/scaffold/general/skills/docs/references/project-knowledge-workflow.md +0 -80
  118. package/scaffold/general/skills/frontend-design/SKILL.md +0 -237
  119. package/scaffold/general/skills/lesson-learned/SKILL.md +0 -113
  120. package/scaffold/general/skills/lesson-learned/references/anti-patterns.md +0 -55
  121. package/scaffold/general/skills/lesson-learned/references/se-principles.md +0 -109
  122. package/scaffold/general/skills/multi-agents-development/SKILL.md +0 -448
  123. package/scaffold/general/skills/multi-agents-development/architecture-review-prompt.md +0 -81
  124. package/scaffold/general/skills/multi-agents-development/code-quality-review-prompt.md +0 -91
  125. package/scaffold/general/skills/multi-agents-development/implementer-prompt.md +0 -93
  126. package/scaffold/general/skills/multi-agents-development/parallel-dispatch-example.md +0 -167
  127. package/scaffold/general/skills/multi-agents-development/spec-review-prompt.md +0 -81
  128. package/scaffold/general/skills/present/SKILL.md +0 -616
  129. package/scaffold/general/skills/react/SKILL.md +0 -309
  130. package/scaffold/general/skills/repo-access/SKILL.md +0 -178
  131. package/scaffold/general/skills/repo-access/references/error-patterns.md +0 -116
  132. package/scaffold/general/skills/repo-access/references/platform-matrix.md +0 -142
  133. package/scaffold/general/skills/requirements-clarity/SKILL.md +0 -333
  134. package/scaffold/general/skills/session-handoff/SKILL.md +0 -199
  135. package/scaffold/general/skills/session-handoff/references/handoff-template.md +0 -139
  136. package/scaffold/general/skills/session-handoff/references/resume-checklist.md +0 -80
  137. package/scaffold/general/skills/session-handoff/scripts/check_staleness.js +0 -269
  138. package/scaffold/general/skills/session-handoff/scripts/create_handoff.js +0 -299
  139. package/scaffold/general/skills/session-handoff/scripts/list_handoffs.js +0 -113
  140. package/scaffold/general/skills/session-handoff/scripts/validate_handoff.js +0 -241
  141. package/scaffold/general/skills/typescript/SKILL.md +0 -405
  142. package/scaffold/generate.mjs +0 -82
@@ -1,142 +0,0 @@
1
- # Platform Matrix
2
-
3
- Use this reference when a repository URL reveals the hosting platform and the skill needs platform-specific authentication or cloning guidance. Prefer platform CLI login flows or OS-backed credential helpers over raw PAT handling.
4
-
5
- ## Platform Detection
6
-
7
- | URL Pattern | Platform | CLI Tool (optional) | Auth Command | No-CLI Alternative |
8
- |---|---|---|---|---|
9
- | `github.com` | GitHub | `gh` | `gh auth login` | PAT + `http` with `Authorization: token <PAT>` |
10
- | Any custom domain (e.g. `ghe.corp.com`, `github.corp.com`) | GitHub Enterprise | `gh` | `gh auth login --hostname <host>` | PAT + `http` against `<host>/api/v3` |
11
- | `gitlab.com` | GitLab | `glab` | `glab auth login` | PAT + `http` with `PRIVATE-TOKEN` header |
12
- | Self-hosted GitLab | GitLab Self-Managed | `glab` | `glab auth login --hostname <host>` | PAT + `http` with `PRIVATE-TOKEN` header |
13
- | `bitbucket.org` | Bitbucket Cloud | None | N/A | App password + `http` with `Authorization: Bearer` |
14
- | `dev.azure.com` or `*.visualstudio.com` | Azure DevOps | `az` + GCM | `az login` | PAT + `http` with Basic auth |
15
- | Gitea instances | Gitea | `tea` (optional) | `tea login add` | PAT + `http` with `Authorization: token` |
16
- | Unknown or custom domain | Ask user which platform | N/A | N/A | Probe `http` or ask before assuming generic Git |
17
-
18
- > **Note:** Platform CLIs (`gh`, `glab`, `az`, `tea`) are native binaries, not npm packages. Do NOT use `npx` to install them — it will fail or install unrelated/unofficial packages. When the CLI is unavailable, use the No-CLI Alternative column.
19
-
20
- ## GitHub / GitHub Enterprise
21
-
22
- - CLI: `gh auth login` uses a browser or device code flow and can open the browser automatically.
23
- - GitHub Enterprise CLI: `gh auth login --hostname <host>`.
24
- - PAT creation: `https://github.com/settings/tokens` for classic tokens.
25
- - PAT creation: `https://github.com/settings/personal-access-tokens` for fine-grained tokens.
26
- - Minimum scopes: `repo` for classic PATs (NOTE: `repo` grants read and write — prefer fine-grained PATs with `Contents: Read` for read-only access).
27
- - Minimum scopes: `Contents: Read` for fine-grained PATs.
28
- - SSH: `git@github.com:owner/repo.git`.
29
- - Credential helper: `gh auth setup-git` configures Git to use the GitHub credential flow.
30
- - Note: Fine-grained PATs may not cover organization-level access or every repo path; classic PATs are still required for some org repos.
31
- - SAML SSO: PATs often require explicit org authorization from `https://github.com/settings/tokens` after creation.
32
- - Enterprise note: PAT URLs and token policy can vary by host; reuse the same auth pattern with the enterprise hostname and instance settings pages.
33
- - Enterprise detection: GHE instances use fully custom domains (e.g. `ghe.coxautoinc.com`, `github.acme.com`). If unsure, probe `https://<host>/api/v3` — a GitHub Enterprise instance returns a JSON response with `installed_version`. Use `gh auth login --hostname <host>` with any custom GHE domain.
34
-
35
- ## GitLab / GitLab Self-Managed
36
-
37
- - CLI: `glab auth login` uses a browser-backed OAuth flow.
38
- - Self-managed CLI: `glab auth login --hostname <host>`.
39
- - PAT creation: `https://gitlab.com/-/user_settings/personal_access_tokens`.
40
- - Minimum scopes: `read_repository`.
41
- - SSH: `git@gitlab.com:owner/repo.git`.
42
- - Credential helper: `glab auth setup-git` configures Git credential handling.
43
- - Note: If 2FA is enabled, username/password Git auth is blocked; a PAT is mandatory for HTTPS auth.
44
- - Self-managed note: PAT URL is typically `https://<host>/-/user_settings/personal_access_tokens` unless the instance customizes settings paths.
45
-
46
- ## Bitbucket Cloud
47
-
48
- - CLI: No official first-party CLI OAuth flow for repo auth.
49
- - PAT/App Password creation: `https://bitbucket.org/{workspace}/settings/app-passwords`.
50
- - Minimum permissions: `Repositories: Read`.
51
- - SSH: `git@bitbucket.org:owner/repo.git`.
52
- - Note: Bitbucket Cloud uses App Passwords rather than standard PAT terminology.
53
- - Note: HTTPS auth requires both the Bitbucket username and the app password, delivered through a credential helper or `GIT_ASKPASS` script — never embedded in the clone URL.
54
-
55
- ## Azure DevOps
56
-
57
- - CLI: `az login` authenticates to Microsoft Entra ID; Git Credential Manager then handles Git credentials automatically.
58
- - PAT-based auth remains the fallback when Entra ID or GCM is unavailable.
59
- - PAT creation: `https://dev.azure.com/{org}/_usersSettings/tokens`.
60
- - Minimum scopes: `Code: Read`.
61
- - SSH: `git@ssh.dev.azure.com:v3/{org}/{project}/{repo}`.
62
- - Note: Microsoft Entra ID tokens are generally preferred over PATs in enterprise environments.
63
- - Credential helper: Git Credential Manager via `git-credential-manager configure`.
64
- - Legacy host note: Azure DevOps may also appear under `*.visualstudio.com` URLs.
65
-
66
- ## Gitea / Forgejo
67
-
68
- - CLI: `tea login add` is available but optional and not universally installed.
69
- - PAT creation: `https://{host}/user/settings/applications`.
70
- - Minimum scopes: `repo`.
71
- - SSH: `git@{host}:owner/repo.git`.
72
- - Note: Forgejo commonly mirrors the same applications-token path and PAT model as Gitea.
73
- - Note: Some self-hosted instances rename scopes or disable API token creation, so confirm the instance policy if `repo` is rejected.
74
-
75
- ## Generic Git (Self-Hosted)
76
-
77
- - Platform CLI: None assumed.
78
- - Auth path: Prefer SSH keys first, then PAT if the host documents HTTPS token auth.
79
- - PAT creation: Ask the user for the platform's PAT or application-token settings URL.
80
- - SSH: Use the host's documented SSH remote format; do not assume GitHub-style shortcuts if the server advertises a different pattern.
81
-
82
- ## API File-Read Endpoints (for web-based code access)
83
-
84
- When agents need to read individual files without cloning, use these authenticated API endpoints.
85
-
86
- ### GitHub / GitHub Enterprise
87
-
88
- ```text
89
- # Read file contents (returns JSON with base64 content)
90
- GET https://api.github.com/repos/{owner}/{repo}/contents/{path}?ref={branch}
91
- Authorization: token <PAT>
92
-
93
- # GHE: replace api.github.com with <ghe-host>/api/v3
94
- GET https://<ghe-host>/api/v3/repos/{owner}/{repo}/contents/{path}?ref={branch}
95
-
96
- # Or use gh CLI (auto-authenticated):
97
- gh api repos/{owner}/{repo}/contents/{path}?ref={branch} --jq '.content' | base64 -d
98
- ```
99
-
100
- ### GitLab / GitLab Self-Managed
101
-
102
- ```text
103
- # URL-encode the file path (/ becomes %2F)
104
- GET https://gitlab.com/api/v4/projects/{project-id}/repository/files/{url-encoded-path}/raw?ref={branch}
105
- PRIVATE-TOKEN: <PAT>
106
-
107
- # Or use project path instead of ID:
108
- GET https://gitlab.com/api/v4/projects/{url-encoded-namespace%2Fproject}/repository/files/{url-encoded-path}/raw?ref={branch}
109
- ```
110
-
111
- ### Azure DevOps
112
-
113
- ```text
114
- GET https://dev.azure.com/{org}/{project}/_apis/git/repositories/{repo}/items?path={path}&api-version=7.0
115
- Authorization: Basic {base64(:PAT)}
116
- ```
117
-
118
- ### Bitbucket Cloud
119
-
120
- ```text
121
- GET https://api.bitbucket.org/2.0/repositories/{workspace}/{repo}/src/{commit-or-branch}/{path}
122
- Authorization: Bearer <app-password-or-token>
123
- ```
124
- - Note: Self-hosted products often customize auth policy, token names, and minimum scopes.
125
-
126
- ## Safe Credential Delivery Patterns
127
-
128
- | Method | Command | Safety |
129
- |---|---|---|
130
- | Platform CLI | `gh auth login` / `glab auth login` | Best — handles credential storage |
131
- | Git Credential Manager | `git credential-manager configure` | Good — OS keychain storage |
132
- | Environment variable | `GH_TOKEN=xxx gh repo clone ...` | OK — ephemeral; safer than URL tokens but visible to same-user processes |
133
- | Git askpass | `GIT_ASKPASS=script git clone ...` | OK — no shell history exposure |
134
- | Inline in URL | `git clone https://token@host/...` | FORBIDDEN — leaks in history/logs |
135
-
136
- ## Operational Notes
137
-
138
- - Prefer SSH when the user already has working keys and the host advertises a stable SSH remote format.
139
- - Prefer platform CLI login for GitHub and GitLab because it also wires Git credential storage.
140
- - Prefer Git Credential Manager for Azure DevOps and other HTTPS-heavy enterprise setups.
141
- - When recommending PAT creation, always suggest setting a short expiry (7-30 days for task-specific work). Prefer fine-grained or short-lived tokens.
142
- - Never recommend pasting tokens inline into clone URLs, scripts checked into the repo, or long-lived shell profiles.
@@ -1,333 +0,0 @@
1
- ---
2
- name: requirements-clarity
3
- description: Clarify ambiguous requirements through focused dialogue before implementation. Use when requirements are unclear, features are complex (>2 days), or involve cross-team coordination. Ask two core questions - Why? (YAGNI check) and Simpler? (KISS check) - to ensure clarity before coding.
4
- metadata:
5
- category: cross-cutting
6
- domain: general
7
- applicability: on-demand
8
- inputs: [requirements]
9
- outputs: [scored-requirements, clarifications]
10
- relatedSkills: [brainstorming]
11
- ---
12
-
13
- # Requirements Clarity Skill
14
-
15
- ## Description
16
-
17
- Automatically transforms vague requirements into actionable PRDs through systematic clarification with a 100-point scoring system.
18
-
19
-
20
- ## Instructions
21
-
22
- When invoked, detect vague requirements:
23
-
24
- 1. **Vague Feature Requests**
25
- - User says: "add login feature", "implement payment", "create dashboard"
26
- - Missing: How, with what technology, what constraints?
27
-
28
- 2. **Missing Technical Context**
29
- - No technology stack mentioned
30
- - No integration points identified
31
- - No performance/security constraints
32
-
33
- 3. **Incomplete Specifications**
34
- - No acceptance criteria
35
- - No success metrics
36
- - No edge cases considered
37
- - No error handling mentioned
38
-
39
- 4. **Ambiguous Scope**
40
- - Unclear boundaries ("user management" - what exactly?)
41
- - No distinction between MVP and future enhancements
42
- - Missing "what's NOT included"
43
-
44
- **Do NOT activate when**:
45
- - Specific file paths mentioned (e.g., "auth.go:45")
46
- - Code snippets included
47
- - Existing functions/classes referenced
48
- - Bug fixes with clear reproduction steps
49
-
50
- ## Core Principles
51
-
52
- 1. **Systematic Questioning**
53
- - Ask focused, specific questions
54
- - One category at a time (2-3 questions per round)
55
- - Build on previous answers
56
- - Avoid overwhelming users
57
-
58
- 2. **Quality-Driven Iteration**
59
- - Continuously assess clarity score (0-100)
60
- - Identify gaps systematically
61
- - Iterate until ≥ 90 points
62
- - Document all clarification rounds
63
-
64
- 3. **Actionable Output**
65
- - Generate concrete specifications
66
- - Include measurable acceptance criteria
67
- - Provide executable phases
68
- - Enable direct implementation
69
-
70
- ## Clarification Process
71
-
72
- ### Step 1: Initial Requirement Analysis
73
-
74
- **Input**: User's requirement description
75
-
76
- **Tasks**:
77
- 1. Parse and understand core requirement
78
- 2. Generate feature name (kebab-case format)
79
- 3. Determine document version (default `1.0` unless user specifies otherwise)
80
- 4. Ensure `.spec/{feature_name}/` exists for PRD output
81
- 5. Perform initial clarity assessment (0-100)
82
-
83
- **Assessment Rubric**:
84
- ```
85
- Functional Clarity: /30 points
86
- - Clear inputs/outputs: 10 pts
87
- - User interaction defined: 10 pts
88
- - Success criteria stated: 10 pts
89
-
90
- Technical Specificity: /25 points
91
- - Technology stack mentioned: 8 pts
92
- - Integration points identified: 8 pts
93
- - Constraints specified: 9 pts
94
-
95
-
96
- If you present this rubric or a requirements scorecard to the user, use `present({ format: 'html' })` to display a rich dashboard when visual formatting would help.
97
- Implementation Completeness: /25 points
98
- - Edge cases considered: 8 pts
99
- - Error handling mentioned: 9 pts
100
- - Data validation specified: 8 pts
101
-
102
- Business Context: /20 points
103
- - Problem statement clear: 7 pts
104
- - Target users identified: 7 pts
105
- - Success metrics defined: 6 pts
106
- ```
107
-
108
- **Initial Response Format**:
109
- ```markdown
110
- I understand your requirement. Let me help you refine this specification.
111
-
112
- **Current Clarity Score**: X/100
113
-
114
- **Clear Aspects**:
115
- - [List what's clear]
116
-
117
- **Needs Clarification**:
118
- - [List gaps]
119
-
120
- Let me systematically clarify these points...
121
- ```
122
-
123
- ### Step 2: Gap Analysis
124
-
125
- Identify missing information across four dimensions:
126
-
127
- **1. Functional Scope**
128
- - What is the core functionality?
129
- - What are the boundaries?
130
- - What is out of scope?
131
- - What are edge cases?
132
-
133
- **2. User Interaction**
134
- - How do users interact?
135
- - What are the inputs?
136
- - What are the outputs?
137
- - What are success/failure scenarios?
138
-
139
- **3. Technical Constraints**
140
- - Performance requirements?
141
- - Compatibility requirements?
142
- - Security considerations?
143
- - Scalability needs?
144
-
145
- **4. Business Value**
146
- - What problem does this solve?
147
- - Who are the target users?
148
- - What are success metrics?
149
- - What is the priority?
150
-
151
- ### Step 3: Interactive Clarification
152
-
153
- **Question Strategy**:
154
- 1. Start with highest-impact gaps
155
- 2. Ask 2-3 questions per round
156
- 3. Build context progressively
157
- 4. Use user's language
158
- 5. Provide examples when helpful
159
-
160
- **Question Format**:
161
- ```markdown
162
- I need to clarify the following points to complete the requirements document:
163
-
164
- 1. **[Category]**: [Specific question]?
165
- - For example: [Example if helpful]
166
-
167
- 2. **[Category]**: [Specific question]?
168
-
169
- 3. **[Category]**: [Specific question]?
170
-
171
- Please provide your answers, and I'll continue refining the PRD.
172
- ```
173
-
174
- **After Each User Response**:
175
- 1. Update clarity score
176
- 2. Capture new information in the working PRD outline
177
- 3. Identify remaining gaps
178
- 4. If score < 90: Continue with next round of questions
179
- 5. If score ≥ 90: Proceed to PRD generation
180
-
181
- **Score Update Format**:
182
- ```markdown
183
- Thank you for the additional information!
184
-
185
- **Clarity Score Update**: X/100 → Y/100
186
-
187
- **New Clarified Content**:
188
- - [Summarize new information]
189
-
190
- **Remaining Points to Clarify**:
191
- - [List remaining gaps if score < 90]
192
-
193
- [If score < 90: Continue with next round of questions]
194
- [If score ≥ 90: "Perfect! I will now generate the complete PRD document..."]
195
- ```
196
-
197
- ### Step 4: PRD Generation
198
-
199
- Once clarity score ≥ 90, generate comprehensive PRD.
200
-
201
- **Output File**:
202
-
203
- 1. **Final PRD**: `.spec/{feature_name}/requirements.md`
204
-
205
- Use `create_file` to save this file. Derive `{version}` from the document version recorded in the PRD (default `1.0`).
206
-
207
- ## PRD Document Structure
208
-
209
- ```markdown
210
- # {Feature Name} - Product Requirements Document (PRD)
211
-
212
- ## Requirements Description
213
-
214
- ### Background
215
- - **Business Problem**: [Describe the business problem to solve]
216
- - **Target Users**: [Target user groups]
217
- - **Value Proposition**: [Value this feature brings]
218
-
219
- ### Feature Overview
220
- - **Core Features**: [List of main features]
221
- - **Feature Boundaries**: [What is and isn't included]
222
- - **User Scenarios**: [Typical usage scenarios]
223
-
224
- ### Detailed Requirements
225
- - **Input/Output**: [Specific input/output specifications]
226
- - **User Interaction**: [User operation flow]
227
- - **Data Requirements**: [Data structures and validation rules]
228
- - **Edge Cases**: [Edge case handling]
229
-
230
- ## Design Decisions
231
-
232
- ### Technical Approach
233
- - **Architecture Choice**: [Technical architecture decisions and rationale]
234
- - **Key Components**: [List of main technical components]
235
- - **Data Storage**: [Data models and storage solutions]
236
- - **Interface Design**: [API/interface specifications]
237
-
238
- ### Constraints
239
- - **Performance Requirements**: [Response time, throughput, etc.]
240
- - **Compatibility**: [System compatibility requirements]
241
- - **Security**: [Security considerations]
242
- - **Scalability**: [Future expansion considerations]
243
-
244
- ### Risk Assessment
245
- - **Technical Risks**: [Potential technical risks and mitigation plans]
246
- - **Dependency Risks**: [External dependencies and alternatives]
247
- - **Schedule Risks**: [Timeline risks and response strategies]
248
-
249
- ## Acceptance Criteria
250
-
251
- ### Functional Acceptance
252
- - [ ] Feature 1: [Specific acceptance conditions]
253
- - [ ] Feature 2: [Specific acceptance conditions]
254
- - [ ] Feature 3: [Specific acceptance conditions]
255
-
256
- ### Quality Standards
257
- - [ ] Code Quality: [Code standards and review requirements]
258
- - [ ] Test Coverage: [Testing requirements and coverage]
259
- - [ ] Performance Metrics: [Performance test pass criteria]
260
- - [ ] Security Review: [Security review requirements]
261
-
262
- ### User Acceptance
263
- - [ ] User Experience: [UX acceptance criteria]
264
- - [ ] Documentation: [Documentation delivery requirements]
265
- - [ ] Training Materials: [If needed, training material requirements]
266
-
267
- ## Execution Phases
268
-
269
- ### Phase 1: Preparation
270
- **Goal**: Environment preparation and technical validation
271
- - [ ] Task 1: [Specific task description]
272
- - [ ] Task 2: [Specific task description]
273
- - **Deliverables**: [Phase deliverables]
274
- - **Time**: [Estimated time]
275
-
276
- ### Phase 2: Core Development
277
- **Goal**: Implement core functionality
278
- - [ ] Task 1: [Specific task description]
279
- - [ ] Task 2: [Specific task description]
280
- - **Deliverables**: [Phase deliverables]
281
- - **Time**: [Estimated time]
282
-
283
- ### Phase 3: Integration & Testing
284
- **Goal**: Integration and quality assurance
285
- - [ ] Task 1: [Specific task description]
286
- - [ ] Task 2: [Specific task description]
287
- - **Deliverables**: [Phase deliverables]
288
- - **Time**: [Estimated time]
289
-
290
- ### Phase 4: Deployment
291
- **Goal**: Release and monitoring
292
- - [ ] Task 1: [Specific task description]
293
- - [ ] Task 2: [Specific task description]
294
- - **Deliverables**: [Phase deliverables]
295
- - **Time**: [Estimated time]
296
-
297
- ---
298
-
299
- **Document Version**: 1.0
300
- **Created**: {timestamp}
301
- **Clarification Rounds**: {clarification_rounds}
302
- **Quality Score**: {quality_score}/100
303
- ```
304
-
305
- ## Behavioral Guidelines
306
-
307
- ### DO
308
- - Ask specific, targeted questions
309
- - Build on previous answers
310
- - Provide examples to guide users
311
- - Maintain conversational tone
312
- - Summarize clarification rounds within the PRD
313
- - Use clear, professional English
314
- - Generate concrete specifications
315
- - Stay in clarification mode until score ≥ 90
316
-
317
- ### DON'T
318
- - Ask all questions at once
319
- - Make assumptions without confirmation
320
- - Generate PRD before 90+ score
321
- - Skip any required sections
322
- - Use vague or abstract language
323
- - Proceed without user responses
324
- - Exit skill mode prematurely
325
-
326
- ## Success Criteria
327
-
328
- - Clarity score ≥ 90/100
329
- - All PRD sections complete with substance
330
- - Acceptance criteria checklistable (using `- [ ]` format)
331
- - Execution phases actionable with concrete tasks
332
- - User approves final PRD
333
- - Ready for development handoff
@@ -1,199 +0,0 @@
1
- ---
2
- name: session-handoff
3
- description: "Creates comprehensive handoff documents for seamless AI agent session transfers. Triggered when: (1) user requests handoff/memory/context save, (2) context window approaches capacity, (3) major task milestone completed, (4) work session ending, (5) user says 'save state', 'create handoff', 'I need to pause', 'context is getting full', (6) resuming work with 'load handoff', 'resume from', 'continue where we left off'. Proactively suggests handoffs after substantial work (multiple file edits, complex debugging, architecture decisions). Solves long-running agent context exhaustion by enabling fresh agents to continue with zero ambiguity."
4
- metadata:
5
- category: cross-cutting
6
- domain: general
7
- applicability: always
8
- inputs: [session-state, decisions]
9
- outputs: [handoff-document]
10
- requires: [aikit]
11
- relatedSkills: [lesson-learned]
12
- ---
13
-
14
- # Handoff
15
-
16
- Creates comprehensive handoff documents that enable fresh AI agents to seamlessly continue work with zero ambiguity. Solves the long-running agent context exhaustion problem.
17
-
18
- ## Mode Selection
19
-
20
- Determine which mode applies:
21
-
22
- **Creating a handoff?** User wants to save current state, pause work, or context is getting full.
23
- - Follow: CREATE Workflow below
24
-
25
- **Resuming from a handoff?** User wants to continue previous work, load context, or mentions an existing handoff.
26
- - Follow: RESUME Workflow below
27
-
28
- **Proactive suggestion?** After substantial work (5+ file edits, complex debugging, major decisions), suggest:
29
- > "We've made significant progress. Consider creating a handoff document to preserve this context for future sessions. Say 'create handoff' when ready."
30
-
31
- > **aikit Integration:** If the project uses the aikit MCP server, complement file-based handoffs with `remember({ title: "Session checkpoint: ...", content: "...", category: "conventions" })` to persist key decisions in the knowledge base. Use `search({ query: "SESSION CHECKPOINT" })` at session start to retrieve past checkpoints.
32
-
33
- ## CREATE Workflow
34
-
35
- ### Step 1: Generate Scaffold
36
-
37
- Run the smart scaffold script to create a pre-filled handoff document:
38
-
39
- ```bash
40
- node scripts/create_handoff.js [task-slug]
41
- ```
42
-
43
- Example: `node scripts/create_handoff.js implementing-user-auth`
44
-
45
- **For continuation handoffs** (linking to previous work):
46
- ```bash
47
- node scripts/create_handoff.js "auth-part-2" --continues-from 2024-01-15-auth.md
48
- ```
49
-
50
- The script will:
51
- - Create `.handoffs/` directory if needed
52
- - Generate timestamped filename
53
- - Pre-fill: timestamp, project path, git branch, recent commits, modified files
54
- - Add handoff chain links if continuing from previous
55
- - Output file path for editing
56
-
57
- ### Step 2: Complete the Handoff Document
58
-
59
- Open the generated file and fill in all `[TODO: ...]` sections. Prioritize these sections:
60
-
61
- 1. **Current State Summary** - What's happening right now
62
- 2. **Important Context** - Critical info the next agent MUST know
63
- 3. **Immediate Next Steps** - Clear, actionable first steps
64
- 4. **Decisions Made** - Choices with rationale (not just outcomes)
65
-
66
- Use the template structure in [references/handoff-template.md](references/handoff-template.md) for guidance.
67
-
68
- ### Step 3: Validate the Handoff
69
-
70
- Run the validation script to check completeness and security:
71
-
72
- ```bash
73
- node scripts/validate_handoff.js <handoff-file>
74
- ```
75
-
76
- The validator checks:
77
- - [ ] No `[TODO: ...]` placeholders remaining
78
- - [ ] Required sections present and populated
79
- - [ ] No potential secrets detected (API keys, passwords, tokens)
80
- - [ ] Referenced files exist
81
- - [ ] Quality score (0-100)
82
-
83
- **Do not finalize a handoff with secrets detected or score below 70.**
84
-
85
- ### Step 4: Confirm Handoff
86
-
87
- Report to user:
88
- - Handoff file location
89
- - Validation score and any warnings
90
- - Summary of captured context
91
- - First action item for next session
92
-
93
- ## RESUME Workflow
94
-
95
- ### Step 1: Find Available Handoffs
96
-
97
- List handoffs in the current project:
98
-
99
- ```bash
100
- node scripts/list_handoffs.js
101
- ```
102
-
103
- This shows all handoffs with dates, titles, and completion status.
104
-
105
- ### Step 2: Check Staleness
106
-
107
- Before loading, check how current the handoff is:
108
-
109
- ```bash
110
- node scripts/check_staleness.js <handoff-file>
111
- ```
112
-
113
- Staleness levels:
114
- - **FRESH**: Safe to resume - minimal changes since handoff
115
- - **SLIGHTLY_STALE**: Review changes, then resume
116
- - **STALE**: Verify context carefully before resuming
117
- - **VERY_STALE**: Consider creating a fresh handoff
118
-
119
- The script checks:
120
- - Time since handoff was created
121
- - Git commits since handoff
122
- - Files changed since handoff
123
- - Branch divergence
124
- - Missing referenced files
125
-
126
- ### Step 3: Load the Handoff
127
-
128
- Read the relevant handoff document completely before taking any action.
129
-
130
- If handoff is part of a chain (has "Continues from" link), also read the linked previous handoff for full context.
131
-
132
- ### Step 4: Verify Context
133
-
134
- Follow the checklist in [references/resume-checklist.md](references/resume-checklist.md):
135
-
136
- 1. Verify project directory and git branch match
137
- 2. Check if blockers have been resolved
138
- 3. Validate assumptions still hold
139
- 4. Review modified files for conflicts
140
- 5. Check environment state
141
-
142
- ### Step 5: Begin Work
143
-
144
- Start with "Immediate Next Steps" item #1 from the handoff document.
145
-
146
- Reference these sections as you work:
147
- - "Critical Files" for important locations
148
- - "Key Patterns Discovered" for conventions to follow
149
- - "Potential Gotchas" to avoid known issues
150
-
151
- ### Step 6: Update or Chain Handoffs
152
-
153
- As you work:
154
- - Mark completed items in "Pending Work"
155
- - Add new discoveries to relevant sections
156
- - For long sessions: create a new handoff with `--continues-from` to chain them
157
-
158
- ## Handoff Chaining
159
-
160
- For long-running projects, chain handoffs together to maintain context lineage:
161
-
162
- ```
163
- handoff-1.md (initial work)
164
-
165
- handoff-2.md --continues-from handoff-1.md
166
-
167
- handoff-3.md --continues-from handoff-2.md
168
- ```
169
-
170
- Each handoff in the chain:
171
- - Links to its predecessor
172
- - Can mark older handoffs as superseded
173
- - Provides context breadcrumbs for new agents
174
-
175
- When resuming from a chain, read the most recent handoff first, then reference predecessors as needed.
176
-
177
- ## Storage Location
178
-
179
- Handoffs are stored in: `.handoffs/`
180
-
181
- Naming convention: `YYYY-MM-DD-HHMMSS-[slug].md`
182
-
183
- Example: `2024-01-15-143022-implementing-auth.md`
184
-
185
- ## Resources
186
-
187
- ### scripts/
188
-
189
- | Script | Purpose |
190
- |--------|---------|
191
- | `create_handoff.js [slug] [--continues-from <file>]` | Generate new handoff with smart scaffolding |
192
- | `list_handoffs.js [path]` | List available handoffs in a project |
193
- | `validate_handoff.js <file>` | Check completeness, quality, and security |
194
- | `check_staleness.js <file>` | Assess if handoff context is still current |
195
-
196
- ### references/
197
-
198
- - [handoff-template.md](references/handoff-template.md) - Complete template structure with guidance
199
- - [resume-checklist.md](references/resume-checklist.md) - Verification checklist for resuming agents