Enhance Claude Code skill with real-world usage patterns (#116)
* Update skill installation path and document new features Installation path changes: - Update from ~/.claude/skills/bd to bd-issue-tracking - Matches internal skill name for consistency with other skills Documentation additions: - Add 3 new reference files to documentation list - Document compaction survival patterns (critical for Claude Code) - Mention self-check checklists and quality guidelines This prepares the README for upcoming skill content improvements. * Add new reference files for enhanced skill guidance New reference documentation: 1. ISSUE_CREATION.md - When to ask vs create issues - Decision criteria for knowledge work vs technical work - Issue quality guidelines and best practices - Design vs acceptance criteria guidance - Self-check questions for well-scoped issues 2. RESUMABILITY.md - Making issues resumable across sessions - Patterns for complex technical work with APIs - Working code examples and API response samples - When enhanced documentation matters vs simple descriptions - Critical for multi-session work and crash recovery 3. STATIC_DATA.md - Using bd for reference databases - Alternative use case beyond work tracking - Glossaries and terminology management - Dual format patterns (database + markdown) - When bd helps vs when simpler formats suffice These additions emerged from real-world usage patterns and enable Claude to make better decisions about issue structure and resumability. * Enhance existing skill files with real-world usage patterns SKILL.md major enhancements (~194 net lines added): - Add "Test Yourself" decision framework with self-check questions - Document compaction survival patterns (critical for Claude Code) - Add Notes Quality Self-Check (future-me test, stranger test) - Session Start Checklist with copy-paste templates - Field Usage Reference table (when to use each bd field) - Progress Checkpointing triggers and patterns - Issue Creation Checklist with quality self-checks - Enhanced session handoff protocols WORKFLOWS.md enhancements (~114 lines added): - Session handoff workflow with detailed checklists - Collaborative handoff between Claude and user - Compaction survival workflow - Notes format guidelines (current state, not cumulative) - Session start checklist expansion BOUNDARIES.md updates (~49 lines removed): - Streamlined content (moved detailed workflows to WORKFLOWS.md) - Retained core decision criteria - Improved examples and integration patterns CLI_REFERENCE.md minor updates: - Additional command examples - Clarified flag usage These improvements emerged from extensive real-world usage, particularly around crash recovery, compaction events, and multi-session workflows. The additions make the skill more practical for autonomous agent use.
This commit is contained in:
@@ -12,7 +12,8 @@ This is a [Claude Code](https://claude.com/claude-code) skill - a markdown-based
|
||||
- Core workflow patterns (discovery, execution, planning phases)
|
||||
- Decision criteria for when to use bd vs TodoWrite/markdown
|
||||
- Session start protocols and ready work checks
|
||||
- Issue lifecycle management
|
||||
- Compaction survival patterns (critical for Claude Code context limits)
|
||||
- Issue lifecycle management with self-check checklists
|
||||
- Integration patterns with other tools
|
||||
|
||||
**Reference documentation:**
|
||||
@@ -20,6 +21,9 @@ This is a [Claude Code](https://claude.com/claude-code) skill - a markdown-based
|
||||
- `references/CLI_REFERENCE.md` - Complete command reference with all flags
|
||||
- `references/DEPENDENCIES.md` - Deep dive into dependency types and relationship patterns
|
||||
- `references/WORKFLOWS.md` - Step-by-step workflows with checklists
|
||||
- `references/ISSUE_CREATION.md` - When to ask vs create issues, quality guidelines
|
||||
- `references/RESUMABILITY.md` - Making issues resumable across sessions with working code examples
|
||||
- `references/STATIC_DATA.md` - Using bd for reference databases and glossaries
|
||||
|
||||
## Why is This Useful?
|
||||
|
||||
@@ -56,17 +60,17 @@ git clone https://github.com/steveyegge/beads.git
|
||||
cd beads/examples/claude-code-skill
|
||||
|
||||
# Create a symlink in your Claude Code skills directory
|
||||
ln -s "$(pwd)" ~/.claude/skills/bd
|
||||
ln -s "$(pwd)" ~/.claude/skills/bd-issue-tracking
|
||||
```
|
||||
|
||||
#### Option 2: Copy Files Directly
|
||||
|
||||
```bash
|
||||
# Create the skill directory
|
||||
mkdir -p ~/.claude/skills/bd
|
||||
mkdir -p ~/.claude/skills/bd-issue-tracking
|
||||
|
||||
# Copy the skill files
|
||||
cp -r beads/examples/claude-code-skill/* ~/.claude/skills/bd/
|
||||
cp -r beads/examples/claude-code-skill/* ~/.claude/skills/bd-issue-tracking/
|
||||
```
|
||||
|
||||
### Verify Installation
|
||||
|
||||
Reference in New Issue
Block a user