66 lines
1.8 KiB
Markdown
66 lines
1.8 KiB
Markdown
---
|
||
name: ck-journal
|
||
description: Write developer journal entries documenting recent code changes, technical decisions, and project events. Use when summarizing work sessions, capturing key changes, or maintaining a development log in docs/journals/.
|
||
---
|
||
|
||
# Journal
|
||
|
||
Write concise journal entries about recent code changes and project events.
|
||
|
||
## When to Use
|
||
|
||
- End of a work session — summarizing what was done
|
||
- After a major feature implementation or milestone
|
||
- Capturing important technical decisions for future reference
|
||
- Maintaining a development log in `./docs/journals/`
|
||
|
||
## Don't Use When
|
||
|
||
- Documenting failures or technical difficulties (use `ck-journal-writer` for honest failure documentation)
|
||
- Writing formal project documentation (use `ck-docs-manager`)
|
||
|
||
## Execution
|
||
|
||
Explore recent git history and code changes, then write concise journal entries:
|
||
|
||
1. Review recent commits and code changes in the repository
|
||
2. Identify the most important events, key changes, impacts, and decisions
|
||
3. Write focused journal entries in `./docs/journals/`
|
||
|
||
## Journal Entry Guidelines
|
||
|
||
- **Concise** — focus on what matters most, not exhaustive detail
|
||
- **Factual** — what changed, why it changed, what impact it has
|
||
- **Forward-looking** — note any follow-up items or decisions made
|
||
- Keep entries focused on significant events, not routine work
|
||
|
||
## Output Location
|
||
|
||
Save journal entries to `./docs/journals/` using the naming pattern from the `## Naming` section injected by session hooks.
|
||
|
||
## Entry Structure
|
||
|
||
```markdown
|
||
# [Brief Title of Session/Event]
|
||
|
||
**Date**: YYYY-MM-DD
|
||
**Component**: [Affected area]
|
||
|
||
## Summary
|
||
|
||
[2–4 sentences on what was done and why]
|
||
|
||
## Key Changes
|
||
|
||
- [Most important change]
|
||
- [Second important change]
|
||
|
||
## Decisions Made
|
||
|
||
- [Any architectural or technical decisions]
|
||
|
||
## Next Steps
|
||
|
||
- [Follow-up items if any]
|
||
```
|