From neely-brain-dump
AI-optimized code documentation framework. Use when writing code, documenting files, creating dependency maps, or asked about documentation best practices.
npx claudepluginhub built-simple/claude-brain-dump-repo --plugin neely-brain-dumpThis skill is limited to using the following tools:
Documentation must live IN the code. External documentation always rots.
Generates systematic documentation for code files or modules via file-by-file analysis, progress tracking, and completeness checks using structured templates. Use for API docs, READMEs, or reference guides.
Creates or updates .meridian/docs/ knowledge files for modules or directories. Generates concise reference docs with frontmatter summaries and read_when keywords for agent context routing.
Captures structured knowledge about code entry points like modules, files, folders, functions, or APIs, analyzes dependencies, and saves docs with mermaid diagrams. Use to document or map code.
Share bugs, ideas, or general feedback.
Documentation must live IN the code. External documentation always rots.
Place at END of EVERY file:
/* ============================================================================
* DEPENDENCY MAP FOR: [filename.js]
* ============================================================================
*
* @module [module-name]
* @criticality [CRITICAL|HIGH|MEDIUM|LOW]
* @created [YYYY-MM-DD]
* @status [ACTIVE|DEPRECATED|MAINTENANCE|EXPERIMENTAL]
*
* PURPOSE:
* [What this module does and why it exists]
*
* DIRECT DEPENDENCIES:
* [REQUIRED] [module/path] - [why needed]
* [OPTIONAL] [module/path] - [graceful degradation behavior]
*
* DATABASE OPERATIONS:
* READS: [table.columns] - [purpose]
* WRITES: [table] - [what triggers writes]
*
* EXTERNAL SERVICES:
* [SERVICE] - Endpoint: [URL], Rate limit: [X/min], Timeout: [Xms]
*
* SIDE EFFECTS:
* - File System: [paths]
* - Cache: [what, TTL]
* - Events: [emitted events]
* - Background Jobs: [triggered jobs]
*
* DEPENDED ON BY:
* [CRITICAL PATH] [module] - [how used]
*
* ERROR HANDLING:
* - [Failure scenario]: [How handled]
*
* BREAKING CHANGES:
* WILL BREAK IF: [specific changes that break this]
*
* PERFORMANCE:
* TIME COMPLEXITY: O([complexity])
* BOTTLENECKS: [operation] - [typical duration]
*
* ============================================================================ */
/**
* @function functionName
* @purpose [One-line description]
* @context [When/why called]
*
* @param {Type} paramName - [description, constraints]
* @returns {Type} - [what it returns]
* @throws {ErrorType} - [when thrown]
*
* @depends [module.function] - [why]
* @affects [what modified] - [side effects]
*
* @performance O([complexity])
* @breaking [what changes break this]
*/
// DEPENDENCY: stripe@^9.0.0 - Payment processing (CRITICAL)
// EXTERNAL: https://api.service.com - Rate limited 100/min
// DB WRITE: users.last_login - Updates activity tracking
// SIDE EFFECT: Triggers email notification job
// CACHE: user:${id} - TTL 5 minutes
// DECISION: Using Redis because [reason]. Revisit if [condition]
// TECHNICAL DEBT: Should use batch processing. Target: Q2 2025
// WORKAROUND: Library bug #1234 - Remove after v2.0
// BUSINESS RULE: [rule] - Legal requirement, DO NOT CHANGE
// GOTCHA: Looks async but requires sequential processing
// CHECKPOINT: [expected state here]
// FAILURE POINT: [what could go wrong]
// CRITICAL: [important business logic]
Create these summary files:
CRITICAL_PATHS.md - User journeys through the system BREAKING_CHANGES.md - Impact analysis for modifications TECH_DEBT.md - Prioritized improvements