study
Build study material for a topic the developer wants to understand before writing about it — a guide in docs/study/<slug>/, tracked as a study task. Use when the developer asks to study a topic, to turn a blog candidate or a report topic into study material, or to prepare before writing a post. Never writes the post.
- License 许可
- MIT
- 最近更新
- 2026-11-04
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- study
- description
- Build study material for a topic the developer wants to understand before writing about it — a guide in docs/study/<slug>/, tracked as a study task. Use when the developer asks to study a topic, to turn a blog candidate or a report topic into study material, or to prepare before writing a post. Never writes the post.
03 SKILL.md 正文
Study material
Writing about what the agent discovered, without studying it first, publishes knowledge that is not yours. This skill builds the material the developer studies, in the extension's Study view, before they write. It never writes the post.
1. The tracker has to be on
Run:
${CLAUDE_PLUGIN_ROOT}/bin/needs-tracker
If it exits non-zero, tell the developer the line it printed, word for word, and stop.
2. Choose the topic
Run, from the project's root:
${CLAUDE_PLUGIN_ROOT}/bin/study-sources
It lists the discoveries the retro marked as blog candidates, and the topics in docs/REPORT.md, each with its slug. The developer chooses one, or describes their own topic. For their own, make the slug with:
${CLAUDE_PLUGIN_ROOT}/bin/study-slug "<title>"
3. Before writing anything
Run:
${CLAUDE_PLUGIN_ROOT}/bin/report-guard start
4. Research
Research the topic in the project's code, its documents, its history (git log, the journal, the pull requests), and in primary sources: the official documentation, the specification, the library's own source. Didactic, but not shallow: explain the mechanism, not only the result.
5. Write the material in docs/study/<slug>/
guide.md is the material, and the whole of it. It has seven sections, with the headings exactly as the contract names them, and the prose in the project's documentation language:
## The problem
## Fundamentals
## What goes wrong without it
## How the project solves it
## Trade-offs
## Sources
## Points for the post
- Every reference to the project cites file and line.
- In Trade-offs, keep three things apart: decisions that were recorded, decisions that are implicit, and what the agent discovered.
- Library behaviour you could not confirm is marked
(inference), with where to check it. - Write it to be studied, not skimmed: the mechanism, worked through, so the developer can explain it in their own words before writing about it.
6. Check it
Run:
${CLAUDE_PLUGIN_ROOT}/bin/study-validate docs/study/<slug>
Fix every line it names until it is silent.
7. Track it
Run:
${CLAUDE_PLUGIN_ROOT}/bin/study-track <slug> "<title>"
It creates the topic's task once, or updates a rebuilt one without touching its status.
8. Prove nothing else was written
Run:
${CLAUDE_PLUGIN_ROOT}/bin/report-guard end docs/study/<slug>/
If it fails, tell the developer exactly what changed. A post, or any other file, is not this skill's to write.
9. Hand over
Tell the developer the topic is ready to study in the Study view, and name the task's id.
04 同仓库更多 Skills
split-markdown
Split a Markdown file that reached the size limit (50 KiB) into a folder of its subjects — one file per top-level section, a README.md index, every inbound link updated — the way the rules prescribe. Use when check-md-size or the pre-commit hook refuses a file, or when the developer asks to split a Markdown file that grew too large. Shows the plan and writes nothing until the developer agrees.
review
End-of-day review with the developer — show each task worked today against its done criterion, and record the developer's acceptance or reopen it with what is missing. Use when the developer asks to review the day or close out today's work, or as the first part of the end-of-day block.
retro
The day's retrospective with the developer — report what was discovered, what surprised, what went wrong and what was decided without asking, take the developer's own "what I want to learn" line and elaborate on it, grounded in the day's work, and write the day's journal entry. Use after the review at the end of the day, or when the developer asks for the retro. Never skipped.
refine
Refinement with the developer — grill the next candidate items or a new idea, propose stories and tasks in the tracker, and agree or reject them on the developer's word, so tomorrow's planning has agreed tasks to pick. Use after the retro at the end of the day, or when the developer asks to refine or plan the next work.
project-report
A read-only report on the project — overview, decisions documented and implicit, critical areas, quality and tests, a study list by risk, and topics worth writing about — written to docs/REPORT.md, which git ignores. Use when the developer asks for a project report, an overview of the codebase, what to study, or what is worth writing about.
planning
Start the working day with the developer — read the tracker and yesterday's journal, propose today's tasks, and claim only what the developer confirms. Use when the developer asks to start the day, plan the day, or plan today's work. Writes no code.