learnship 2.0.11 → 2.1.1

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 (79) hide show
  1. package/.claude-plugin/plugin.json +2 -2
  2. package/.cursor-plugin/plugin.json +2 -2
  3. package/README.md +59 -14
  4. package/SKILL.md +24 -2
  5. package/agents/learnship-doc-writer.md +63 -0
  6. package/agents/learnship-security-auditor.md +67 -0
  7. package/bin/install.js +2 -0
  8. package/commands/learnship/discuss-phase.md +1 -1
  9. package/commands/learnship/docs-update.md +22 -0
  10. package/commands/learnship/execute-phase.md +2 -6
  11. package/commands/learnship/extract-learnings.md +22 -0
  12. package/commands/learnship/forensics.md +21 -0
  13. package/commands/learnship/help.md +2 -1
  14. package/commands/learnship/ideate.md +1 -1
  15. package/commands/learnship/milestone-summary.md +22 -0
  16. package/commands/learnship/note.md +22 -0
  17. package/commands/learnship/plan-phase.md +0 -1
  18. package/commands/learnship/quick.md +1 -5
  19. package/commands/learnship/secure-phase.md +23 -0
  20. package/commands/learnship/session-report.md +21 -0
  21. package/commands/learnship/undo.md +22 -0
  22. package/commands/learnship/verify-work.md +1 -1
  23. package/cursor-rules/learnship.mdc +12 -2
  24. package/gemini-extension.json +2 -2
  25. package/hooks/session-start +12 -1
  26. package/learnship/agents/doc-writer.md +63 -0
  27. package/learnship/agents/security-auditor.md +67 -0
  28. package/learnship/references/common-bug-patterns.md +92 -0
  29. package/learnship/references/context-budget.md +49 -0
  30. package/learnship/references/domain-probes.md +133 -0
  31. package/learnship/references/gates.md +72 -0
  32. package/learnship/references/planning-config.md +99 -9
  33. package/learnship/references/thinking-models.md +61 -0
  34. package/learnship/references/universal-anti-patterns.md +51 -0
  35. package/learnship/templates/agents.md +3 -0
  36. package/learnship/templates/context.md +207 -32
  37. package/learnship/templates/discussion-log.md +49 -0
  38. package/learnship/templates/security.md +61 -0
  39. package/learnship/templates/ui-spec.md +107 -0
  40. package/learnship/workflows/complete-milestone.md +4 -5
  41. package/learnship/workflows/compound.md +2 -0
  42. package/learnship/workflows/debug.md +2 -0
  43. package/learnship/workflows/discuss-phase.md +73 -15
  44. package/learnship/workflows/docs-update.md +144 -0
  45. package/learnship/workflows/execute-phase.md +35 -6
  46. package/learnship/workflows/extract-learnings.md +161 -0
  47. package/learnship/workflows/forensics.md +118 -0
  48. package/learnship/workflows/help.md +20 -2
  49. package/learnship/workflows/ideate.md +63 -4
  50. package/learnship/workflows/ls.md +1 -1
  51. package/learnship/workflows/milestone-summary.md +150 -0
  52. package/learnship/workflows/new-project.md +78 -8
  53. package/learnship/workflows/next.md +1 -1
  54. package/learnship/workflows/note.md +110 -0
  55. package/learnship/workflows/pause-work.md +2 -0
  56. package/learnship/workflows/plan-phase.md +17 -2
  57. package/learnship/workflows/quick.md +28 -8
  58. package/learnship/workflows/review.md +1 -0
  59. package/learnship/workflows/secure-phase.md +147 -0
  60. package/learnship/workflows/session-report.md +133 -0
  61. package/learnship/workflows/settings.md +40 -46
  62. package/learnship/workflows/ship.md +2 -0
  63. package/learnship/workflows/undo.md +151 -0
  64. package/learnship/workflows/verify-work.md +36 -4
  65. package/package.json +1 -1
  66. package/references/common-bug-patterns.md +92 -0
  67. package/references/context-budget.md +49 -0
  68. package/references/domain-probes.md +133 -0
  69. package/references/gates.md +72 -0
  70. package/references/planning-config.md +139 -0
  71. package/references/solution-schema.md +159 -0
  72. package/references/thinking-models.md +61 -0
  73. package/references/universal-anti-patterns.md +51 -0
  74. package/templates/agents.md +80 -7
  75. package/templates/config.json +28 -3
  76. package/templates/context.md +207 -32
  77. package/templates/discussion-log.md +49 -0
  78. package/templates/security.md +61 -0
  79. package/templates/ui-spec.md +107 -0
@@ -6,67 +6,242 @@ workflow: discuss-phase
6
6
 
7
7
  # Phase [N] Context: [Phase Name]
8
8
 
9
- Implementation decisions captured during `discuss-phase [N]`. This file is read by the planner, researcher, and executor it represents locked user preferences that override default approaches.
9
+ Implementation decisions captured during `discuss-phase [N]`. This file is the primary input for downstream agents — the researcher uses it to know WHAT to investigate, the planner uses it to know WHAT choices are locked.
10
10
 
11
- ---
11
+ <domain>
12
+ ## Phase Boundary
13
+
14
+ [Clear statement of what this phase delivers — the scope anchor. This comes from ROADMAP.md and is fixed. Discussion clarifies implementation within this boundary.]
15
+
16
+ </domain>
12
17
 
18
+ <decisions>
13
19
  ## Implementation Decisions
14
20
 
15
- ### Technology Choices
21
+ ### [Area 1 that was discussed]
22
+ - **D-01:** [Specific decision made]
23
+ - **D-02:** [Another decision if applicable]
24
+
25
+ ### [Area 2 that was discussed]
26
+ - **D-03:** [Specific decision made]
27
+
28
+ ### [Area 3 that was discussed]
29
+ - **D-04:** [Specific decision made]
30
+
31
+ ### Claude's Discretion
32
+ [Areas where user explicitly said "you decide" — the agent has flexibility here during planning/implementation]
33
+
34
+ </decisions>
35
+
36
+ <specifics>
37
+ ## Specific Ideas
38
+
39
+ [Any particular references, examples, or "I want it like X" moments from discussion. Product references, specific behaviors, interaction patterns.]
16
40
 
17
- *What specific libraries, frameworks, or tools should be used?*
41
+ [If none: "No specific requirements open to standard approaches"]
18
42
 
19
- - [Decision]: [Choice] — [rationale]
20
- - [Decision]: [Choice] — [rationale]
43
+ </specifics>
21
44
 
22
- ### Architecture Preferences
45
+ <canonical_refs>
46
+ ## Canonical References
23
47
 
24
- *How should this be structured? Patterns, layers, component organization?*
48
+ **Downstream agents MUST read these before planning or implementing.**
25
49
 
26
- - [Decision]: [Choice] [rationale]
50
+ [List every spec, ADR, feature doc, or design doc that defines requirements or constraints for this phase. Use full relative paths so agents can read them directly.]
27
51
 
28
- ### Scope Boundaries
52
+ ### [Topic area 1]
53
+ - `path/to/spec-or-adr.md` — [What this doc decides/defines that's relevant]
29
54
 
30
- *What's explicitly in scope vs. explicitly deferred?*
55
+ ### [Topic area 2]
56
+ - `path/to/feature-doc.md` — [What capability this defines]
31
57
 
32
- **In scope for this phase:**
33
- - [item]
34
- - [item]
58
+ [If the project has no external specs: "No external specs — requirements are fully captured in decisions above"]
35
59
 
36
- **Explicitly deferred (do not implement):**
37
- - [item]
38
- - [item]
60
+ </canonical_refs>
39
61
 
40
- ### UI/UX Decisions
62
+ <code_context>
63
+ ## Existing Code Insights
41
64
 
42
- *Visual style, interaction patterns, design direction (if UI work)*
65
+ ### Reusable Assets
66
+ - [Component/hook/utility]: [How it could be used in this phase]
43
67
 
44
- - [Decision]: [Choice] — [rationale]
68
+ ### Established Patterns
69
+ - [Pattern]: [How it constrains/enables this phase]
45
70
 
46
71
  ### Integration Points
72
+ - [Where new code connects to existing system]
47
73
 
48
- *How should this phase connect to other phases or existing systems?*
74
+ </code_context>
49
75
 
50
- - [item]: [approach]
76
+ <deferred>
77
+ ## Deferred Ideas
51
78
 
52
- ### Quality Standards
79
+ [Ideas that came up during discussion but belong in other phases. Captured here so they're not lost, but explicitly out of scope for this phase.]
53
80
 
54
- *Performance targets, error handling approach, test coverage expectations*
81
+ [If none: "None discussion stayed within phase scope"]
55
82
 
56
- - [item]: [requirement]
83
+ </deferred>
57
84
 
58
85
  ---
59
86
 
60
- ## Open Questions
87
+ *Phase: [padded]-[slug]*
88
+ *Context gathered: [date]*
61
89
 
62
- *Unresolved items — planner should make a reasonable default choice and note it*
90
+ ---
63
91
 
64
- - [question]: [status — TBD / will decide during planning / not critical]
92
+ <good_examples>
65
93
 
66
- ---
94
+ **Example 1: Visual feature (Post Feed)**
95
+
96
+ ```markdown
97
+ # Phase 3: Post Feed - Context
98
+
99
+ **Gathered:** 2025-01-20
100
+ **Status:** Ready for planning
101
+
102
+ <domain>
103
+ ## Phase Boundary
104
+
105
+ Display posts from followed users in a scrollable feed. Users can view posts and see engagement counts. Creating posts and interactions are separate phases.
106
+ </domain>
107
+
108
+ <decisions>
109
+ ## Implementation Decisions
67
110
 
68
- ## Anti-Patterns to Avoid
111
+ ### Layout style
112
+ - Card-based layout, not timeline or list
113
+ - Each card shows: author avatar, name, timestamp, full post content, reaction counts
114
+ - Cards have subtle shadows, rounded corners — modern feel
69
115
 
70
- *Approaches the user explicitly wants to avoid*
116
+ ### Loading behavior
117
+ - Infinite scroll, not pagination
118
+ - Pull-to-refresh on mobile
119
+ - New posts indicator at top ("3 new posts") rather than auto-inserting
120
+
121
+ ### Empty state
122
+ - Friendly illustration + "Follow people to see posts here"
123
+ - Suggest 3-5 accounts to follow based on interests
124
+
125
+ ### Claude's Discretion
126
+ - Loading skeleton design
127
+ - Exact spacing and typography
128
+ - Error state handling
129
+ </decisions>
130
+
131
+ <specifics>
132
+ ## Specific Ideas
133
+
134
+ - "I like how Twitter shows the new posts indicator without disrupting your scroll position"
135
+ - Cards should feel like Linear's issue cards — clean, not cluttered
136
+ </specifics>
137
+
138
+ <canonical_refs>
139
+ ## Canonical References
140
+
141
+ ### Feed display
142
+ - `docs/features/social-feed.md` — Feed requirements, post card fields, engagement display rules
143
+
144
+ ### Empty states
145
+ - `docs/design/empty-states.md` — Empty state patterns, illustration guidelines
146
+ </canonical_refs>
147
+
148
+ <deferred>
149
+ ## Deferred Ideas
150
+
151
+ - Commenting on posts — Phase 5
152
+ - Bookmarking posts — add to backlog
153
+ </deferred>
154
+ ```
155
+
156
+ **Example 2: CLI tool (Database backup)**
157
+
158
+ ```markdown
159
+ # Phase 2: Backup Command - Context
160
+
161
+ **Gathered:** 2025-01-20
162
+ **Status:** Ready for planning
163
+
164
+ <domain>
165
+ ## Phase Boundary
166
+
167
+ CLI command to backup database to local file or S3. Supports full and incremental backups. Restore command is a separate phase.
168
+ </domain>
169
+
170
+ <decisions>
171
+ ## Implementation Decisions
71
172
 
72
- - [anti-pattern]: [reason]
173
+ ### Output format
174
+ - JSON for programmatic use, table format for humans
175
+ - Default to table, --json flag for JSON
176
+ - Verbose mode (-v) shows progress, silent by default
177
+
178
+ ### Flag design
179
+ - Short flags for common options: -o (output), -v (verbose), -f (force)
180
+ - Long flags for clarity: --incremental, --compress, --encrypt
181
+ - Required: database connection string (positional or --db)
182
+
183
+ ### Error recovery
184
+ - Retry 3 times on network failure, then fail with clear message
185
+ - --no-retry flag to fail fast
186
+ - Partial backups are deleted on failure (no corrupt files)
187
+
188
+ ### Claude's Discretion
189
+ - Exact progress bar implementation
190
+ - Compression algorithm choice
191
+ - Temp file handling
192
+ </decisions>
193
+
194
+ <specifics>
195
+ ## Specific Ideas
196
+
197
+ - "I want it to feel like pg_dump — familiar to database people"
198
+ - Should work in CI pipelines (exit codes, no interactive prompts)
199
+ </specifics>
200
+
201
+ <canonical_refs>
202
+ ## Canonical References
203
+
204
+ ### Backup CLI
205
+ - `docs/features/backup-restore.md` — Backup requirements, supported backends, encryption spec
206
+ - `docs/decisions/adr-007-cli-conventions.md` — Flag naming, exit codes, output format standards
207
+ </canonical_refs>
208
+
209
+ <deferred>
210
+ ## Deferred Ideas
211
+
212
+ - Scheduled backups — separate phase
213
+ - Backup rotation/retention — add to backlog
214
+ </deferred>
215
+ ```
216
+
217
+ </good_examples>
218
+
219
+ <guidelines>
220
+ **This template captures DECISIONS for downstream agents.**
221
+
222
+ The output should answer: "What does the researcher need to investigate? What choices are locked for the planner?"
223
+
224
+ **Good content (concrete decisions):**
225
+ - "Card-based layout, not timeline"
226
+ - "Retry 3 times on network failure, then fail"
227
+ - "Group by year, then by month"
228
+ - "JSON for programmatic use, table for humans"
229
+
230
+ **Bad content (too vague):**
231
+ - "Should feel modern and clean"
232
+ - "Good user experience"
233
+ - "Fast and responsive"
234
+ - "Easy to use"
235
+
236
+ **After creation:**
237
+ - File lives in phase directory: `.planning/phases/XX-name/{phase_num}-CONTEXT.md`
238
+ - The researcher uses decisions to focus investigation AND reads canonical_refs to know WHAT docs to study
239
+ - The planner uses decisions + research to create executable tasks AND reads canonical_refs to verify alignment
240
+ - Downstream agents should NOT need to ask the user again about captured decisions
241
+
242
+ **Canonical references:**
243
+ - The `<canonical_refs>` section is MANDATORY. Every CONTEXT.md must have one.
244
+ - If your project has external specs, ADRs, or design docs, list them with full relative paths grouped by topic
245
+ - If ROADMAP.md lists `Canonical refs:` per phase, extract and expand those
246
+ - If no external specs exist, say so explicitly — don't silently omit the section
247
+ </guidelines>
@@ -0,0 +1,49 @@
1
+ ---
2
+ phase: [N]
3
+ slug: [phase-slug]
4
+ areas_discussed: []
5
+ created: [date]
6
+ ---
7
+
8
+ # Phase [N]: [Name] - Discussion Log
9
+
10
+ > **Audit trail only.** Do not use as input to planning, research, or execution agents.
11
+ > Decisions are captured in CONTEXT.md — this log preserves the alternatives considered.
12
+
13
+ **Date:** [ISO date]
14
+ **Phase:** [phase number]-[phase name]
15
+ **Areas discussed:** [comma-separated list]
16
+
17
+ ---
18
+
19
+ ## [Area 1 Name]
20
+
21
+ | Option | Description | Selected |
22
+ |--------|-------------|----------|
23
+ | [Option 1] | [Brief description] | |
24
+ | [Option 2] | [Brief description] | ✓ |
25
+ | [Option 3] | [Brief description] | |
26
+
27
+ **User's choice:** [Selected option or verbatim free-text response]
28
+ **Notes:** [Any clarifications or rationale provided during discussion]
29
+
30
+ ---
31
+
32
+ ## [Area 2 Name]
33
+
34
+ ...
35
+
36
+ ---
37
+
38
+ ## Claude's Discretion
39
+
40
+ [Areas delegated to Claude's judgment — list what was deferred and why]
41
+
42
+ ## Deferred Ideas
43
+
44
+ [Ideas mentioned but not in scope for this phase]
45
+
46
+ ---
47
+
48
+ *Phase: [padded]-[slug]*
49
+ *Discussion log generated: [date]*
@@ -0,0 +1,61 @@
1
+ ---
2
+ phase: {N}
3
+ slug: {phase-slug}
4
+ status: draft
5
+ threats_open: 0
6
+ created: {date}
7
+ ---
8
+
9
+ # Phase {N} — Security
10
+
11
+ > Per-phase security contract: threat register, accepted risks, and audit trail.
12
+
13
+ ---
14
+
15
+ ## Trust Boundaries
16
+
17
+ | Boundary | Description | Data Crossing |
18
+ |----------|-------------|---------------|
19
+ | {boundary} | {description} | {data type / sensitivity} |
20
+
21
+ ---
22
+
23
+ ## Threat Register
24
+
25
+ | Threat ID | Category | Component | Disposition | Mitigation | Status |
26
+ |-----------|----------|-----------|-------------|------------|--------|
27
+ | T-{N}-01 | {STRIDE category} | {component} | {mitigate / accept / transfer} | {control or reference} | open |
28
+
29
+ *Status: open · closed*
30
+ *Disposition: mitigate (implementation required) · accept (documented risk) · transfer (third-party)*
31
+ *STRIDE categories: Spoofing · Tampering · Repudiation · Information Disclosure · Denial of Service · Elevation of Privilege*
32
+
33
+ ---
34
+
35
+ ## Accepted Risks Log
36
+
37
+ | Risk ID | Threat Ref | Rationale | Accepted By | Date |
38
+ |---------|------------|-----------|-------------|------|
39
+
40
+ *Accepted risks do not resurface in future audit runs.*
41
+
42
+ *If none: "No accepted risks."*
43
+
44
+ ---
45
+
46
+ ## Security Audit Trail
47
+
48
+ | Audit Date | Threats Total | Closed | Open | Run By |
49
+ |------------|---------------|--------|------|--------|
50
+ | {YYYY-MM-DD} | {N} | {N} | {N} | {name / agent} |
51
+
52
+ ---
53
+
54
+ ## Sign-Off
55
+
56
+ - [ ] All threats have a disposition (mitigate / accept / transfer)
57
+ - [ ] Accepted risks documented in Accepted Risks Log
58
+ - [ ] `threats_open: 0` confirmed
59
+ - [ ] `status: verified` set in frontmatter
60
+
61
+ **Approval:** {pending / verified YYYY-MM-DD}
@@ -0,0 +1,107 @@
1
+ ---
2
+ phase: {N}
3
+ slug: {phase-slug}
4
+ status: draft
5
+ created: {date}
6
+ ---
7
+
8
+ # Phase {N} — UI Design Contract
9
+
10
+ > Visual and interaction contract for frontend phases. Verified against impeccable standards.
11
+
12
+ ---
13
+
14
+ ## Design System
15
+
16
+ | Property | Value |
17
+ |----------|-------|
18
+ | Component library | {library or "none"} |
19
+ | Icon library | {library} |
20
+ | Font | {font} |
21
+ | CSS approach | {tailwind / css modules / styled-components / etc.} |
22
+
23
+ ---
24
+
25
+ ## Spacing Scale
26
+
27
+ Declared values (must be multiples of 4):
28
+
29
+ | Token | Value | Usage |
30
+ |-------|-------|-------|
31
+ | xs | 4px | Icon gaps, inline padding |
32
+ | sm | 8px | Compact element spacing |
33
+ | md | 16px | Default element spacing |
34
+ | lg | 24px | Section padding |
35
+ | xl | 32px | Layout gaps |
36
+ | 2xl | 48px | Major section breaks |
37
+ | 3xl | 64px | Page-level spacing |
38
+
39
+ Exceptions: {list any, or "none"}
40
+
41
+ ---
42
+
43
+ ## Typography
44
+
45
+ | Role | Size | Weight | Line Height |
46
+ |------|------|--------|-------------|
47
+ | Body | {px} | {weight} | {ratio} |
48
+ | Label | {px} | {weight} | {ratio} |
49
+ | Heading | {px} | {weight} | {ratio} |
50
+ | Display | {px} | {weight} | {ratio} |
51
+
52
+ ---
53
+
54
+ ## Color
55
+
56
+ | Role | Value | Usage |
57
+ |------|-------|-------|
58
+ | Primary | {hex} | Buttons, links, active states |
59
+ | Secondary | {hex} | Supporting actions |
60
+ | Neutral | {hex} | Text, borders, backgrounds |
61
+ | Success | {hex} | Confirmations, positive states |
62
+ | Warning | {hex} | Cautions, pending states |
63
+ | Error | {hex} | Errors, destructive actions |
64
+
65
+ ---
66
+
67
+ ## Key Components
68
+
69
+ | Component | Spec |
70
+ |-----------|------|
71
+ | {component} | {key constraints: size, padding, border-radius, shadow} |
72
+
73
+ ---
74
+
75
+ ## Interaction Patterns
76
+
77
+ | Pattern | Behavior |
78
+ |---------|----------|
79
+ | Loading | {skeleton / spinner / progressive} |
80
+ | Empty state | {illustration + CTA / minimal text / guided action} |
81
+ | Error state | {inline / toast / modal / redirect} |
82
+ | Transitions | {duration, easing, what animates} |
83
+
84
+ ---
85
+
86
+ ## Responsive Breakpoints
87
+
88
+ | Breakpoint | Width | Layout Changes |
89
+ |------------|-------|----------------|
90
+ | Mobile | < 640px | {description} |
91
+ | Tablet | 640-1024px | {description} |
92
+ | Desktop | > 1024px | {description} |
93
+
94
+ ---
95
+
96
+ ## Impeccable Checklist
97
+
98
+ - [ ] No overused fonts (Inter, Roboto, Arial)
99
+ - [ ] No AI palette (cyan-on-dark, purple-to-blue gradients)
100
+ - [ ] No pure black (#000) or pure white (#fff) — tinted neutrals
101
+ - [ ] No nested cards inside cards
102
+ - [ ] No large rounded icons above every heading
103
+ - [ ] At least one intentional, memorable design decision
104
+ - [ ] Typography has clear visual hierarchy with modular scale
105
+ - [ ] Spacing creates rhythm through variation, not uniformity
106
+
107
+ **If someone saw this interface and immediately thought AI made it — that is the problem.**