Agent skill
documentation
Best practices for session documentation - incremental summaries, fix reports, and audit trails
Install this agent skill to your Project
npx add-skill https://github.com/Delphine-L/claude_global/tree/main/skills/claude-meta/documentation
SKILL.md
Documentation Skills
Best practices for creating effective documentation during Claude Code sessions.
Session Documentation
Incremental Summary Documents
When working through multiple related issues in a session:
-
Create summary after each major fix:
FIX_SUMMARY.md- First issue resolvedFISH_CLASSIFICATION_FIX_SUMMARY.md- Second issueTAXONOMY_COMPLETE_SUMMARY.md- Final state
-
Benefits:
- User can reference specific fixes
- Clear audit trail of changes
- Easy to see what was done and why
- Supports future troubleshooting
-
Include in each summary:
- Problem statement: What was the issue?
- Root cause: Why did it happen?
- Species/items affected: With counts for verification
- Solution applied: Step-by-step what was done
- Files modified: Complete list with paths
- Verification results: Show the fix worked
- Next steps: What to do with the results
Example Structure
# [Issue Name] - [STATUS]
## Problem
[Clear description of what was wrong]
## Root Cause
[Why the problem occurred]
## Items Fixed (N total)
| Item | Details | Category |
|------|---------|----------|
| ... | ... | ... |
## Solution Applied
1. [Step 1]
2. [Step 2]
...
## Verification Results
✓ [What was verified]
✓ [Counts match]
## Files Modified
1. `file1.txt` - [what changed]
2. `file2.txt` - [what changed]
## Next Steps
[What the user should do now]
When to Create Summaries
- After fixing a significant bug: Document root cause and solution
- After completing a major task: Show what was accomplished
- After each iteration in multi-step fixes: Track progress
- At session end: Comprehensive final state summary
Documentation File Naming
Use descriptive names that indicate:
- What was fixed:
FISH_CLASSIFICATION_FIX_SUMMARY.md - Scope:
TAXONOMY_COMPLETE_SUMMARY.md - Status: Include "FIXED", "COMPLETE", "FINAL" in filename
Avoid generic names like SUMMARY.md or NOTES.md.
Related Skills
- Skill Management: Capturing learnings from documentation
- Token Efficiency: Concise yet complete documentation
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
Delphine-L/claude_global
conda-recipe
Expert in building and testing conda/bioconda recipes, including recipe creation, linting, dependency management, and debugging common build errors
Delphine-L/claude_global
bioinformatics-visualization
Publication-quality bioinformatics figures - phylogenetic trees, genome browsers, iTOL datasets, and data presentation
Delphine-L/claude_global
phylogenetics
Phylogenetic tree analysis, visualization, annotation management, and iTOL troubleshooting
Delphine-L/claude_global
bioinformatics-fundamentals
Core bioinformatics concepts including SAM/BAM format, AGP genome assembly format, sequencing technologies (Hi-C, HiFi, Illumina), quality metrics, and common data processing patterns. Essential for debugging alignment, filtering, pairing issues, and AGP coordinate validation.
Delphine-L/claude_global
project-sharing
Prepare organized packages of project files for sharing at different levels - from summary PDFs to fully reproducible archives. Creates copies with cleaned notebooks, documentation, and appropriate file selection. After creating sharing package, all work continues in the main project directory.
Delphine-L/claude_global
hackmd
HackMD collaborative markdown - slide presentations, embedded SVG diagrams, and real-time editing best practices
Didn't find tool you were looking for?