Claude
Skills
Sign in
← Back

documentation

Included with Lifetime
$97 forever

Best practices for session documentation - incremental summaries, fix reports, and audit trails

Security

What this skill does


# 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:

1. **Create summary after each major fix**:
   - `FIX_SUMMARY.md` - First issue resolved
   - `FISH_CLASSIFICATION_FIX_SUMMARY.md` - Second issue
   - `TAXONOMY_COMPLETE_SUMMARY.md` - Final state

2. **Benefits**:
   - User can reference specific fixes
   - Clear audit trail of changes
   - Easy to see what was done and why
   - Supports future troubleshooting

3. **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

```markdown
# [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
Files: 1
Size: 2.3 KB
Complexity: 10/100
Category: Security
Source: https://github.com/delphine-l/claude_global/tree/main/skills/claude-meta/documentation

Related in Security

mac-ops

Included

Comprehensive macOS workstation operations — diagnose kernel panics, identify failing drives, audit launchd startup items, decode wake reasons, triage TCC permission denials, manage APFS snapshots, recover from no-boot. Use for: Mac is slow, slow bootup, won't boot, kernel panic, kernel_task hot, mds_stores CPU, photoanalysisd, cloudd, login loop, gray screen, sleep wake failure, drive failing, IO errors, APFS snapshots eating space, Time Machine local snapshots, Spotlight indexing, launchd, LaunchAgent, LaunchDaemon, login items, TCC permissions, Full Disk Access, Screen Recording denied, Gatekeeper, quarantine, com.apple.quarantine, app is damaged, helper tool, /Library/PrivilegedHelperTools, pmset, wake reasons, dark wake, sysdiagnose, panic.ips, DiagnosticReports, configuration profile, MDM profile, remote diagnostics over SSH.

Securityscripts

a11y-audit

Included

Run accessibility audits on web projects combining automated scanning (axe-core, Lighthouse) with WCAG 2.1 AA compliance mapping, manual check guidance, and structured reporting. Output is configurable: markdown report only, markdown plus machine-readable JSON, or markdown plus issue tracker integration. Use this skill whenever the user mentions "accessibility audit", "a11y audit", "WCAG audit", "accessibility check", "compliance scan", or asks to check a web project for accessibility issues. Also trigger when the user wants to verify WCAG conformance or map findings to a specific standard (CAN-ASC-6.2, EN 301 549, ADA/AODA).

Securityscripts

erpclaw

Included

AI-native ERP system with self-extending OS. Full accounting, invoicing, inventory, purchasing, tax, billing, HR, payroll, advanced accounting (ASC 606/842, intercompany, consolidation), and financial reporting. 413 actions across 14 domains, 43 expansion modules. Constitutional guardrails, adversarial audit, schema migration. Double-entry GL, immutable audit trail, US GAAP.

Securityscripts

assess

Included

Assesses and rates quality 0-10 across multiple dimensions (correctness, maintainability, security, performance, testability, simplicity) with pros/cons analysis. Compares against project conventions and prior decisions from memory. Produces structured evaluation reports with actionable improvement suggestions. Use when evaluating code, designs, architectures, or comparing alternative approaches.

Securityscripts

spring-boot-security-jwt

Included

Provides JWT authentication and authorization patterns for Spring Boot 3.5.x covering token generation with JJWT, Bearer/cookie authentication, database/OAuth2 integration, and RBAC/permission-based access control using Spring Security 6.x. Use when implementing authentication or authorization in Spring Boot applications.

Securityscripts

code-hardcode-audit

Included

Detect hardcoded values, magic numbers, and leaked secrets. TRIGGERS - hardcode audit, magic numbers, PLR2004, secret scanning.

Securityscripts
Sign up & unlock — $97