cs-scientist-plugin 0.1.0
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/PROTOCOL.md +431 -0
- package/README.md +256 -0
- package/agents/cs-scientist-arbiter.md +124 -0
- package/agents/cs-scientist-consultant.md +111 -0
- package/agents/cs-scientist-critic.md +234 -0
- package/agents/cs-scientist-dev.md +439 -0
- package/agents/cs-scientist-research.md +426 -0
- package/agents/cs-scientist-teach.md +430 -0
- package/agents/cs-scientist.md +201 -0
- package/agents/planner.md +41 -0
- package/agents/writer.md +35 -0
- package/bin/install.js +109 -0
- package/index.js +3 -0
- package/package.json +40 -0
- package/skills/concept-explainer.md +78 -0
- package/skills/deep-research.md +98 -0
- package/skills/kb-validate.md +101 -0
- package/skills/lesson-plan.md +107 -0
- package/skills/negative-results.md +100 -0
- package/skills/notebooklm.md +95 -0
- package/skills/paper-outline.md +143 -0
- package/skills/parallel-research.md +85 -0
- package/skills/project-onboarding.md +118 -0
- package/skills/session-status.md +79 -0
- package/skills/writing-plans/SKILL.md +152 -0
- package/skills/writing-plans/plan-document-reviewer-prompt.md +49 -0
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: >-
|
|
3
|
+
Post-investigation transformation skill. Converts a cs-scientist report.md
|
|
4
|
+
into alternative formats: podcast script, FAQ, or executive briefing.
|
|
5
|
+
Never modifies the KB or the report. Always runs after Phase 10 DOCUMENT —
|
|
6
|
+
never during the research or dev loop.
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# notebooklm
|
|
10
|
+
|
|
11
|
+
## Input
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
$ARGUMENTS — path to report.md, OR topic name if report is in the active session
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
If $ARGUMENTS is a topic name, look for the report at:
|
|
18
|
+
`.cs-scientist/{matching_session_id}/report.md`
|
|
19
|
+
|
|
20
|
+
## Output formats
|
|
21
|
+
|
|
22
|
+
Ask the user which format they want if not specified in $ARGUMENTS:
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
¿Qué formato quieres?
|
|
26
|
+
A) Podcast — guión conversacional entre dos personas, ~1500 palabras
|
|
27
|
+
B) FAQ — 10-15 preguntas y respuestas para alguien nuevo en el tema
|
|
28
|
+
C) Briefing ejecutivo — resumen ejecutivo de 1 página, orientado a decisiones
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### A — Podcast script
|
|
32
|
+
|
|
33
|
+
Two speakers: HOST (generalist, asks questions) and EXPERT (domain knowledge).
|
|
34
|
+
Structure: hook (30s) → context (2min) → 3-4 key findings (5-6min) → implications (2min) → close (30s).
|
|
35
|
+
Tone: accessible, no jargon without explanation.
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
[PODCAST: {topic}]
|
|
39
|
+
Based on: {report.md path}
|
|
40
|
+
|
|
41
|
+
HOST: ...
|
|
42
|
+
EXPERT: ...
|
|
43
|
+
[continues for ~1500 words]
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
KEY SOURCES MENTIONED: {3-5 most important sources from the report}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### B — FAQ
|
|
50
|
+
|
|
51
|
+
10-15 questions a knowledgeable non-specialist would ask.
|
|
52
|
+
Derive questions from: Open Questions in KB, hypotheses, contradictions, limitations.
|
|
53
|
+
Each answer cites the report section, not the original source.
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
[FAQ: {topic}]
|
|
57
|
+
Based on: {report.md path}
|
|
58
|
+
|
|
59
|
+
Q1: {question}
|
|
60
|
+
A: {answer in 2-4 sentences, cites report section}
|
|
61
|
+
|
|
62
|
+
...
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
QUESTIONS WITHOUT CLEAR ANSWERS (from KB Open Questions):
|
|
66
|
+
- {question that the research did not resolve}
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### C — Executive briefing
|
|
70
|
+
|
|
71
|
+
One page. Decision-oriented. Three sections only:
|
|
72
|
+
```
|
|
73
|
+
[EXECUTIVE BRIEFING: {topic}]
|
|
74
|
+
Based on: {report.md path} | Date: {ISO8601}
|
|
75
|
+
|
|
76
|
+
SITUATION: {1 paragraph — what is known with confidence}
|
|
77
|
+
IMPLICATIONS: {2-3 bullets — what this means for decisions}
|
|
78
|
+
UNCERTAINTIES: {2-3 bullets — what is still unknown and why it matters}
|
|
79
|
+
RECOMMENDED NEXT STEP: {1 concrete action}
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Rules
|
|
83
|
+
|
|
84
|
+
- Every claim in the output must trace to the report — not to new information
|
|
85
|
+
- Do not introduce new claims or interpretations not present in the report
|
|
86
|
+
- Do not modify report.md or knowledge_base.md — read only
|
|
87
|
+
- If the report has no [VERIFIED] findings yet, stop and notify:
|
|
88
|
+
`El report no tiene hallazgos verificados. Completa Phase 10 DOCUMENT antes de usar esta skill.`
|
|
89
|
+
|
|
90
|
+
## NEVER
|
|
91
|
+
|
|
92
|
+
- NEVER run during the research loop — only after DOCUMENT is complete
|
|
93
|
+
- NEVER add new claims not in the report
|
|
94
|
+
- NEVER modify the KB or the report file
|
|
95
|
+
- NEVER present [HYPOTHESIS] items as confirmed findings in any output format
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: >-
|
|
3
|
+
Converts a cs-scientist research session (knowledge_base.md + report.md) into
|
|
4
|
+
an academic paper skeleton following standard structure. Does not write the
|
|
5
|
+
paper — produces the skeleton with guidance on what goes where, derived
|
|
6
|
+
entirely from verified KB findings. Run after Phase 10 DOCUMENT is complete.
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# paper-outline
|
|
10
|
+
|
|
11
|
+
## Input
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
$ARGUMENTS — session directory path, OR topic name, OR empty to use active session
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
If $ARGUMENTS is empty or a topic name: scan `.cs-scientist/` for matching research sessions.
|
|
18
|
+
|
|
19
|
+
## Pre-condition check
|
|
20
|
+
|
|
21
|
+
Read `session_state.json`. If mode ≠ research or phase ≠ DOCUMENT:
|
|
22
|
+
```
|
|
23
|
+
Esta skill requiere una sesión de research completada (Phase 10 DOCUMENT).
|
|
24
|
+
Sesión actual: modo={mode}, fase={phase}.
|
|
25
|
+
Completa la investigación antes de usar paper-outline.
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## What you read
|
|
29
|
+
|
|
30
|
+
- `knowledge_base.md` — primary source. Every paper section maps to specific KB tags.
|
|
31
|
+
- `report.md` (if exists) — already synthesized findings; use as guide for the Abstract and Discussion.
|
|
32
|
+
|
|
33
|
+
## KB → Paper section mapping
|
|
34
|
+
|
|
35
|
+
| KB tags | Paper section |
|
|
36
|
+
|---------|--------------|
|
|
37
|
+
| `[FACT]`, `[VERIFIED]` | Results, Background |
|
|
38
|
+
| `[SYNTHESIS]` | Discussion, Conclusions |
|
|
39
|
+
| `[HYPOTHESIS]` | Future Work, Limitations |
|
|
40
|
+
| `[REFUTED]` | Negative Results (Appendix or Discussion) |
|
|
41
|
+
| Open Questions | Future Work |
|
|
42
|
+
| [DECISION] entries (if dev session mixed) | Methods |
|
|
43
|
+
|
|
44
|
+
## Output format
|
|
45
|
+
|
|
46
|
+
```markdown
|
|
47
|
+
# Paper Outline: {topic}
|
|
48
|
+
*Derivado de sesión: {session_id} | {date}*
|
|
49
|
+
*Formato sugerido: {NeurIPS | ICML | Nature | arXiv preprint — inferred from topic domain}*
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## Abstract (150-250 words)
|
|
54
|
+
**Derivar de:** {top 3 VERIFIED findings from KB}
|
|
55
|
+
Estructura obligatoria: [Problema] [Por qué importa] [Nuestro enfoque] [Resultado principal] [Implicación]
|
|
56
|
+
|
|
57
|
+
Hallazgos candidatos para incluir:
|
|
58
|
+
- {VERIFIED finding 1}
|
|
59
|
+
- {VERIFIED finding 2}
|
|
60
|
+
- {VERIFIED finding 3}
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## 1. Introduction
|
|
65
|
+
**Derivar de:** {problem framing from SCOPE, motivation from KB background}
|
|
66
|
+
Estructura: Hook → Gap en el estado del arte → Contribución → Estructura del paper
|
|
67
|
+
|
|
68
|
+
Contenido candidato de KB:
|
|
69
|
+
- {relevant FACT or VERIFIED item}
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## 2. Related Work
|
|
74
|
+
**Derivar de:** {FACT items with citations, SYNTHESIS items connecting prior work}
|
|
75
|
+
Agrupar en subsecciones por: {identified clusters from KB — e.g., "Approaches A", "Approaches B"}
|
|
76
|
+
|
|
77
|
+
Fuentes KB con cita completa: {N items — list titles and years}
|
|
78
|
+
Fuentes a buscar para completar: {Open Questions that require more literature}
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## 3. Methods / Approach
|
|
83
|
+
**Derivar de:** {DESIGN artifacts if dev, or methodology from research phases}
|
|
84
|
+
Estructura: [Setup / datos] [Procedimiento] [Criterios de evaluación]
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## 4. Results
|
|
89
|
+
**Derivar de:** {all VERIFIED items — the confirmed findings}
|
|
90
|
+
Cada subsección = un hallazgo verificado.
|
|
91
|
+
|
|
92
|
+
Hallazgos confirmados para este bloque:
|
|
93
|
+
{list all [VERIFIED] KB items with source citations}
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## 5. Discussion
|
|
98
|
+
**Derivar de:** {SYNTHESIS items, connections between findings}
|
|
99
|
+
Estructura: [Lo que significan los resultados] [Por qué son sorprendentes o esperados] [Limitaciones]
|
|
100
|
+
|
|
101
|
+
Candidatos de discusión de KB:
|
|
102
|
+
{list [SYNTHESIS] items}
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## 6. Limitations
|
|
107
|
+
**Derivar de:** {HYPOTHESIS items not verified, Open Questions not resolved, [REFUTED] items that revealed scope limits}
|
|
108
|
+
|
|
109
|
+
- {limitation 1 — source in KB}
|
|
110
|
+
- {limitation 2 — source in KB}
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
## 7. Future Work
|
|
115
|
+
**Derivar de:** {unresolved Open Questions, LOW-confidence HYPOTHESIS items}
|
|
116
|
+
|
|
117
|
+
- {future direction 1 — linked to KB open question}
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
## Appendix A — Negative Results (Optional but recommended)
|
|
122
|
+
**Derivar de:** {[REFUTED] items, gate failures documented in negative_results.md if available}
|
|
123
|
+
Incluir si hay ≥2 hipótesis refutadas — es metodológicamente valioso.
|
|
124
|
+
|
|
125
|
+
---
|
|
126
|
+
|
|
127
|
+
## References
|
|
128
|
+
{all cited sources from KB — grouped by section where cited}
|
|
129
|
+
Formato: {inferred from target venue — APA / IEEE / Nature / ACM}
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
ADVERTENCIAS:
|
|
134
|
+
{list of KB items marked [HYPOTHESIS] that appear in Results — these need more validation before submission}
|
|
135
|
+
{list of SYNTHESIS items used as if VERIFIED — these need explicit hedging language}
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
## NEVER
|
|
139
|
+
|
|
140
|
+
- NEVER include [HYPOTHESIS] items in Results without flagging them
|
|
141
|
+
- NEVER omit Limitations — a paper without limitations is not credible
|
|
142
|
+
- NEVER suggest a venue if you cannot match the topic domain to it with confidence
|
|
143
|
+
- NEVER write the paper — only the skeleton with content guidance derived from KB
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: >-
|
|
3
|
+
Dispatches multiple research angles as independent parallel searches.
|
|
4
|
+
Used in cs-scientist-research Phase 2 DECOMPOSE to accelerate RETRIEVE.
|
|
5
|
+
Each angle is searched independently with no cross-contamination between
|
|
6
|
+
searches. Results are consolidated in KB-compatible format.
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# parallel-research
|
|
10
|
+
|
|
11
|
+
## Input
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
$ARGUMENTS — list of research angles from DECOMPOSE, one per line
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Format expected:
|
|
18
|
+
```
|
|
19
|
+
TOPIC: {main research question}
|
|
20
|
+
ANGLES:
|
|
21
|
+
1. {angle 1 — searchable independently}
|
|
22
|
+
2. {angle 2 — searchable independently}
|
|
23
|
+
3. {angle 3 — searchable independently}
|
|
24
|
+
...
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## What you do
|
|
28
|
+
|
|
29
|
+
Search each angle as a fully independent research task. Do not let findings from angle N
|
|
30
|
+
influence the search strategy for angle N+1. Cross-contamination defeats the purpose of
|
|
31
|
+
parallel independent searches.
|
|
32
|
+
|
|
33
|
+
### Per angle — search protocol
|
|
34
|
+
|
|
35
|
+
For each angle:
|
|
36
|
+
1. Search across ≥3 source types (academic, industry, primary data minimum)
|
|
37
|
+
2. Extract and tag each claim (same tags as deep-research: `[FACT]`, `[HYPOTHESIS]`, etc.)
|
|
38
|
+
3. Note contradictions within the angle
|
|
39
|
+
4. Estimate coverage: `low` (<5 sources) / `medium` (5-10) / `high` (>10)
|
|
40
|
+
|
|
41
|
+
### Output format
|
|
42
|
+
|
|
43
|
+
```
|
|
44
|
+
PARALLEL-RESEARCH: {main topic}
|
|
45
|
+
ANGLES_SEARCHED: {N}
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
ANGLE 1: {angle name}
|
|
50
|
+
COVERAGE: low | medium | high
|
|
51
|
+
FACTS:
|
|
52
|
+
- [FACT] {claim} — Source: {title}, {year}, {URL}
|
|
53
|
+
HYPOTHESES:
|
|
54
|
+
- [HYPOTHESIS] {claim} | Supporting: {source}
|
|
55
|
+
CONTRADICTIONS:
|
|
56
|
+
- {claim}: FOR {source} | AGAINST {source}
|
|
57
|
+
OPEN_QUESTIONS:
|
|
58
|
+
- {unresolved question specific to this angle}
|
|
59
|
+
|
|
60
|
+
ANGLE 2: {angle name}
|
|
61
|
+
...
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
CROSS-ANGLE PATTERNS:
|
|
66
|
+
- {pattern that appears across multiple angles — mark as [SYNTHESIS] candidate}
|
|
67
|
+
|
|
68
|
+
COVERAGE_GAPS:
|
|
69
|
+
- {angle with low coverage that needs more research}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Integration with cs-scientist-research
|
|
73
|
+
|
|
74
|
+
Call this skill from Phase 2 DECOMPOSE when the angles are defined.
|
|
75
|
+
Output feeds directly into Phase 3 RETRIEVE — skip manual search for covered angles.
|
|
76
|
+
Low-coverage angles still require manual search in Phase 3.
|
|
77
|
+
|
|
78
|
+
CROSS-ANGLE PATTERNS go into KB as `[SYNTHESIS]` candidates — they are model-generated
|
|
79
|
+
connections, not verified facts. Label them explicitly.
|
|
80
|
+
|
|
81
|
+
## NEVER
|
|
82
|
+
|
|
83
|
+
- NEVER mix findings between angles during search — search each independently
|
|
84
|
+
- NEVER mark cross-angle patterns as [FACT] — they are [SYNTHESIS] candidates until verified
|
|
85
|
+
- NEVER skip low-coverage angles — flag them as gaps, do not omit them from output
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: >-
|
|
3
|
+
Generates a concise onboarding document for a new team member joining a
|
|
4
|
+
project. Reads AGENTS.md/CLAUDE.md, README, recent git history, and project
|
|
5
|
+
configuration files to produce a "Day 1" guide: what the project does, how to
|
|
6
|
+
run it, key architectural decisions, and where to start.
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# project-onboarding
|
|
10
|
+
|
|
11
|
+
## Input
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
$ARGUMENTS — project root path, OR empty to use current project
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
If $ARGUMENTS is empty: `git rev-parse --show-toplevel 2>/dev/null || pwd`
|
|
18
|
+
|
|
19
|
+
## What you read
|
|
20
|
+
|
|
21
|
+
Read these files in order. Stop reading a file after 200 lines — if it is longer, skim for
|
|
22
|
+
the sections most relevant to a new developer.
|
|
23
|
+
|
|
24
|
+
| File | What to extract |
|
|
25
|
+
|------|----------------|
|
|
26
|
+
| `AGENTS.md` or `CLAUDE.md` | Project type, stack, architecture, commands, constraints |
|
|
27
|
+
| `README.md` | Purpose, setup instructions, any quickstart |
|
|
28
|
+
| `package.json` / `pyproject.toml` / `Cargo.toml` / `go.mod` | Dependencies, scripts |
|
|
29
|
+
| `CHANGELOG.md` | Last 3 entries — what changed recently |
|
|
30
|
+
| `.gitignore` | What kind of artifacts the project generates (inferred from ignores) |
|
|
31
|
+
|
|
32
|
+
Then run:
|
|
33
|
+
```bash
|
|
34
|
+
git log --oneline -15
|
|
35
|
+
```
|
|
36
|
+
to get recent commit history. Identify the 3 most active areas of the codebase.
|
|
37
|
+
|
|
38
|
+
## Output format
|
|
39
|
+
|
|
40
|
+
```markdown
|
|
41
|
+
# Onboarding: {project name}
|
|
42
|
+
*Generado el {date} desde el estado actual del repositorio*
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## ¿Qué es este proyecto?
|
|
47
|
+
{1-2 sentences. What problem does it solve? Who uses it?}
|
|
48
|
+
|
|
49
|
+
## Stack
|
|
50
|
+
|
|
51
|
+
| | |
|
|
52
|
+
|-|-|
|
|
53
|
+
| Lenguaje(s) | {languages} |
|
|
54
|
+
| Framework(s) | {frameworks} |
|
|
55
|
+
| Arquitectura | {pattern} |
|
|
56
|
+
| Tipo | {web app / CLI / library / pipeline / etc.} |
|
|
57
|
+
|
|
58
|
+
## Cómo arrancarlo
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
{exact commands from AGENTS.md or README — no guessing}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Cómo testear
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
{exact test command}
|
|
68
|
+
```
|
|
69
|
+
Criterio de done: {done criterion from AGENTS.md}
|
|
70
|
+
|
|
71
|
+
## Estructura del proyecto
|
|
72
|
+
|
|
73
|
+
{top-level directory listing with one-line purpose per directory}
|
|
74
|
+
```
|
|
75
|
+
dir/ → {what lives here}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Decisiones de arquitectura que necesitas conocer
|
|
79
|
+
|
|
80
|
+
{from AGENTS.md "decisiones no obvias" section, or inferred from code structure}
|
|
81
|
+
- {decision}: {why it was made this way}
|
|
82
|
+
|
|
83
|
+
## Lo que NUNCA debes hacer
|
|
84
|
+
|
|
85
|
+
{from AGENTS.md "qué NUNCA debe hacer un agente" — applies to humans too}
|
|
86
|
+
- {constraint}
|
|
87
|
+
|
|
88
|
+
## Actividad reciente (últimos 15 commits)
|
|
89
|
+
|
|
90
|
+
{3 bullets: what areas have changed, what is actively being worked on}
|
|
91
|
+
|
|
92
|
+
## Por dónde empezar
|
|
93
|
+
|
|
94
|
+
{based on git log + structure: what is the main entry point? what is the core flow?}
|
|
95
|
+
1. Lee: `{most important file to read first}`
|
|
96
|
+
2. Ejecuta: `{command that shows the system working}`
|
|
97
|
+
3. Modifica: `{smallest safe change to make to verify the dev loop works}`
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
*Este documento es una instantánea. Para el estado actual consulta AGENTS.md y git log.*
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
## Rules
|
|
104
|
+
|
|
105
|
+
- Only include information derivable from the files — no fabrication
|
|
106
|
+
- If a command is not in the files, write `{no encontrado — verificar con el equipo}` rather than guessing
|
|
107
|
+
- The "Por dónde empezar" section must be concrete and executable, not vague
|
|
108
|
+
|
|
109
|
+
## Save behavior
|
|
110
|
+
|
|
111
|
+
Ask: "¿Guardo esto como `ONBOARDING.md` en el proyecto? [S/n]"
|
|
112
|
+
Default yes. If yes, save to project root. If the file already exists, show a diff summary and ask before overwriting.
|
|
113
|
+
|
|
114
|
+
## NEVER
|
|
115
|
+
|
|
116
|
+
- NEVER invent commands — only use what appears in the files
|
|
117
|
+
- NEVER include secrets, API keys, or credentials even if found in config files
|
|
118
|
+
- NEVER create this file without asking first — the user decides if it should be committed
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: >-
|
|
3
|
+
Shows the current state of an active cs-scientist session. Reads
|
|
4
|
+
session_state.json, goals.md, and the last 5 entries of activity_log.jsonl
|
|
5
|
+
to produce a human-readable status report. Essential after context
|
|
6
|
+
compaction or when returning to a session after a break.
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# session-status
|
|
10
|
+
|
|
11
|
+
## Input
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
$ARGUMENTS — session directory path, OR empty to scan .cs-scientist/ in current project
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
If $ARGUMENTS is empty:
|
|
18
|
+
1. Run `git rev-parse --show-toplevel 2>/dev/null || pwd` to find project root
|
|
19
|
+
2. List all sessions in `{project_root}/.cs-scientist/`
|
|
20
|
+
3. If multiple: ask which one. If one: use it. If none: report no active session.
|
|
21
|
+
|
|
22
|
+
## What you read
|
|
23
|
+
|
|
24
|
+
- `session_state.json` — current phase, gate status, next action
|
|
25
|
+
- `goals.md` — goal progress
|
|
26
|
+
- `activity_log.jsonl` — last 5 entries (what happened recently)
|
|
27
|
+
|
|
28
|
+
## Output format
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
SESSION STATUS
|
|
32
|
+
──────────────────────────────────────────────
|
|
33
|
+
Session: {session_id}
|
|
34
|
+
Mode: {research | dev}
|
|
35
|
+
Topic: {topic}
|
|
36
|
+
──────────────────────────────────────────────
|
|
37
|
+
|
|
38
|
+
PHASE
|
|
39
|
+
Current: {phase} ({phase_status})
|
|
40
|
+
Blocked: {blocked_reason or "—"}
|
|
41
|
+
|
|
42
|
+
GATES
|
|
43
|
+
GATE_1: {pending | pass | fail}
|
|
44
|
+
GATE_2: {pending | pass | fail}
|
|
45
|
+
GATE_3: {pending | pass | fail} ← research only
|
|
46
|
+
GATE_1_DEV: {pending | pass | fail} ← dev only
|
|
47
|
+
GATE_2_DEV: {pending | pass | fail} ← dev only
|
|
48
|
+
|
|
49
|
+
GOALS
|
|
50
|
+
Active ({N}):
|
|
51
|
+
● HIGH {goal description}
|
|
52
|
+
○ MEDIUM {goal description}
|
|
53
|
+
Completed ({N}): {last completed goal | "—"}
|
|
54
|
+
Blocked ({N}): {blocked goal | "—"}
|
|
55
|
+
|
|
56
|
+
RECENT ACTIVITY (last 5 actions)
|
|
57
|
+
{ts short} [{agent}] {summary}
|
|
58
|
+
{ts short} [{agent}] {summary}
|
|
59
|
+
...
|
|
60
|
+
|
|
61
|
+
NEXT ACTION
|
|
62
|
+
{next_action from session_state.json}
|
|
63
|
+
|
|
64
|
+
──────────────────────────────────────────────
|
|
65
|
+
Switch to cs-scientist-{research|dev} and paste:
|
|
66
|
+
SESSION: {full path to session_state.json}
|
|
67
|
+
TOPIC: {topic}
|
|
68
|
+
NEXT_ACTION: {next_action}
|
|
69
|
+
──────────────────────────────────────────────
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
The last block (the ready-to-paste dispatch input) makes resuming a session after compaction
|
|
73
|
+
a single copy-paste operation.
|
|
74
|
+
|
|
75
|
+
## NEVER
|
|
76
|
+
|
|
77
|
+
- NEVER modify any session file — read only
|
|
78
|
+
- NEVER infer state — only report what is in the files
|
|
79
|
+
- NEVER omit the ready-to-paste block — it is the primary value of this skill after compaction
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: writing-plans
|
|
3
|
+
description: Use when you have a spec or requirements for a multi-step task, before touching code
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Writing Plans
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
Write comprehensive implementation plans assuming the engineer has zero context for our codebase and questionable taste. Document everything they need to know: which files to touch for each task, code, testing, docs they might need to check, how to test it. Give them the whole plan as bite-sized tasks. DRY. YAGNI. TDD. Frequent commits.
|
|
11
|
+
|
|
12
|
+
Assume they are a skilled developer, but know almost nothing about our toolset or problem domain. Assume they don't know good test design very well.
|
|
13
|
+
|
|
14
|
+
**Announce at start:** "I'm using the writing-plans skill to create the implementation plan."
|
|
15
|
+
|
|
16
|
+
**Context:** This should be run in a dedicated worktree (created by brainstorming skill).
|
|
17
|
+
|
|
18
|
+
**Save plans to:** `docs/superpowers/plans/YYYY-MM-DD-<feature-name>.md`
|
|
19
|
+
- (User preferences for plan location override this default)
|
|
20
|
+
|
|
21
|
+
## Scope Check
|
|
22
|
+
|
|
23
|
+
If the spec covers multiple independent subsystems, it should have been broken into sub-project specs during brainstorming. If it wasn't, suggest breaking this into separate plans — one per subsystem. Each plan should produce working, testable software on its own.
|
|
24
|
+
|
|
25
|
+
## File Structure
|
|
26
|
+
|
|
27
|
+
Before defining tasks, map out which files will be created or modified and what each one is responsible for. This is where decomposition decisions get locked in.
|
|
28
|
+
|
|
29
|
+
- Design units with clear boundaries and well-defined interfaces. Each file should have one clear responsibility.
|
|
30
|
+
- You reason best about code you can hold in context at once, and your edits are more reliable when files are focused. Prefer smaller, focused files over large ones that do too much.
|
|
31
|
+
- Files that change together should live together. Split by responsibility, not by technical layer.
|
|
32
|
+
- In existing codebases, follow established patterns. If the codebase uses large files, don't unilaterally restructure - but if a file you're modifying has grown unwieldy, including a split in the plan is reasonable.
|
|
33
|
+
|
|
34
|
+
This structure informs the task decomposition. Each task should produce self-contained changes that make sense independently.
|
|
35
|
+
|
|
36
|
+
## Bite-Sized Task Granularity
|
|
37
|
+
|
|
38
|
+
**Each step is one action (2-5 minutes):**
|
|
39
|
+
- "Write the failing test" - step
|
|
40
|
+
- "Run it to make sure it fails" - step
|
|
41
|
+
- "Implement the minimal code to make the test pass" - step
|
|
42
|
+
- "Run the tests and make sure they pass" - step
|
|
43
|
+
- "Commit" - step
|
|
44
|
+
|
|
45
|
+
## Plan Document Header
|
|
46
|
+
|
|
47
|
+
**Every plan MUST start with this header:**
|
|
48
|
+
|
|
49
|
+
```markdown
|
|
50
|
+
# [Feature Name] Implementation Plan
|
|
51
|
+
|
|
52
|
+
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
|
53
|
+
|
|
54
|
+
**Goal:** [One sentence describing what this builds]
|
|
55
|
+
|
|
56
|
+
**Architecture:** [2-3 sentences about approach]
|
|
57
|
+
|
|
58
|
+
**Tech Stack:** [Key technologies/libraries]
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Task Structure
|
|
64
|
+
|
|
65
|
+
````markdown
|
|
66
|
+
### Task N: [Component Name]
|
|
67
|
+
|
|
68
|
+
**Files:**
|
|
69
|
+
- Create: `exact/path/to/file.py`
|
|
70
|
+
- Modify: `exact/path/to/existing.py:123-145`
|
|
71
|
+
- Test: `tests/exact/path/to/test.py`
|
|
72
|
+
|
|
73
|
+
- [ ] **Step 1: Write the failing test**
|
|
74
|
+
|
|
75
|
+
```python
|
|
76
|
+
def test_specific_behavior():
|
|
77
|
+
result = function(input)
|
|
78
|
+
assert result == expected
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
- [ ] **Step 2: Run test to verify it fails**
|
|
82
|
+
|
|
83
|
+
Run: `pytest tests/path/test.py::test_name -v`
|
|
84
|
+
Expected: FAIL with "function not defined"
|
|
85
|
+
|
|
86
|
+
- [ ] **Step 3: Write minimal implementation**
|
|
87
|
+
|
|
88
|
+
```python
|
|
89
|
+
def function(input):
|
|
90
|
+
return expected
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
- [ ] **Step 4: Run test to verify it passes**
|
|
94
|
+
|
|
95
|
+
Run: `pytest tests/path/test.py::test_name -v`
|
|
96
|
+
Expected: PASS
|
|
97
|
+
|
|
98
|
+
- [ ] **Step 5: Commit**
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
git add tests/path/test.py src/path/file.py
|
|
102
|
+
git commit -m "feat: add specific feature"
|
|
103
|
+
```
|
|
104
|
+
````
|
|
105
|
+
|
|
106
|
+
## No Placeholders
|
|
107
|
+
|
|
108
|
+
Every step must contain the actual content an engineer needs. These are **plan failures** — never write them:
|
|
109
|
+
- "TBD", "TODO", "implement later", "fill in details"
|
|
110
|
+
- "Add appropriate error handling" / "add validation" / "handle edge cases"
|
|
111
|
+
- "Write tests for the above" (without actual test code)
|
|
112
|
+
- "Similar to Task N" (repeat the code — the engineer may be reading tasks out of order)
|
|
113
|
+
- Steps that describe what to do without showing how (code blocks required for code steps)
|
|
114
|
+
- References to types, functions, or methods not defined in any task
|
|
115
|
+
|
|
116
|
+
## Remember
|
|
117
|
+
- Exact file paths always
|
|
118
|
+
- Complete code in every step — if a step changes code, show the code
|
|
119
|
+
- Exact commands with expected output
|
|
120
|
+
- DRY, YAGNI, TDD, frequent commits
|
|
121
|
+
|
|
122
|
+
## Self-Review
|
|
123
|
+
|
|
124
|
+
After writing the complete plan, look at the spec with fresh eyes and check the plan against it. This is a checklist you run yourself — not a subagent dispatch.
|
|
125
|
+
|
|
126
|
+
**1. Spec coverage:** Skim each section/requirement in the spec. Can you point to a task that implements it? List any gaps.
|
|
127
|
+
|
|
128
|
+
**2. Placeholder scan:** Search your plan for red flags — any of the patterns from the "No Placeholders" section above. Fix them.
|
|
129
|
+
|
|
130
|
+
**3. Type consistency:** Do the types, method signatures, and property names you used in later tasks match what you defined in earlier tasks? A function called `clearLayers()` in Task 3 but `clearFullLayers()` in Task 7 is a bug.
|
|
131
|
+
|
|
132
|
+
If you find issues, fix them inline. No need to re-review — just fix and move on. If you find a spec requirement with no task, add the task.
|
|
133
|
+
|
|
134
|
+
## Execution Handoff
|
|
135
|
+
|
|
136
|
+
After saving the plan, offer execution choice:
|
|
137
|
+
|
|
138
|
+
**"Plan complete and saved to `docs/superpowers/plans/<filename>.md`. Two execution options:**
|
|
139
|
+
|
|
140
|
+
**1. Subagent-Driven (recommended)** - I dispatch a fresh subagent per task, review between tasks, fast iteration
|
|
141
|
+
|
|
142
|
+
**2. Inline Execution** - Execute tasks in this session using executing-plans, batch execution with checkpoints
|
|
143
|
+
|
|
144
|
+
**Which approach?"**
|
|
145
|
+
|
|
146
|
+
**If Subagent-Driven chosen:**
|
|
147
|
+
- **REQUIRED SUB-SKILL:** Use superpowers:subagent-driven-development
|
|
148
|
+
- Fresh subagent per task + two-stage review
|
|
149
|
+
|
|
150
|
+
**If Inline Execution chosen:**
|
|
151
|
+
- **REQUIRED SUB-SKILL:** Use superpowers:executing-plans
|
|
152
|
+
- Batch execution with checkpoints for review
|