agentleFS
tranhieutttranhieutt/software_development_department/.claude/skills/update-codemap/SKILL.md

update-codemap

Skill71 starsChanged 7 months agoMITView on GitHub

Update docs/technical/CODEMAP.md to accurately reflect the current state of the codebase. A stale CODEMAP misleads agents more than having none. Run this skill after any significant feature merge, refactor, or directory restructure. If $ARGUMENTS is provided, update only the section(s) relevant to the named module or area. If $ARGUMENTS is empty, perform a full CODEMAP refresh. Read docs/technical/CODEMAP.md to understand what is currently documented. Run the following to get the current structure: Also read docs/technical/API.md and docs/technical/DATABASE.md if they exist…

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

10 rules. About 0 are common, 5 are distinctive, and 5 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 5

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Update docs/technical/CODEMAP.md to accurately reflect the current state of the codebase.

    line 12
  2. Very specific:

    If $ARGUMENTS is provided, update only the section(s) relevant to the named module or area.

    line 20
  3. Very specific:

    If $ARGUMENTS is empty, perform a full CODEMAP refresh.

    line 22
  4. Very specific:

    Read docs/technical/CODEMAP.md to understand what is currently documented.

    line 26
  5. Distinctive:

    Run the following to get the current structure:

    line 30
  6. Distinctive:

    Remove rows for modules/files that no longer exist

    line 56
  7. Distinctive:

    Add rows for new modules/files

    line 57
  8. Distinctive:

    Keep descriptions concise — one sentence max

    line 58
  9. Very specific:

    If a section has no entries yet, keep the *(not yet populated)* placeholder row

    line 59
  10. Distinctive:

    Do not over-document — only include modules that other agents would need to find

    line 60

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Update docs/technical/CODEMAP.md to accurately reflect the current state of the codebase.

A stale CODEMAP misleads agents more than having none. Run this skill after any significant feature merge, refactor, or directory restructure.

Steps

1. Determine scope

If $ARGUMENTS is provided, update only the section(s) relevant to the named module or area.

If $ARGUMENTS is empty, perform a full CODEMAP refresh.

2. Read current CODEMAP

Read docs/technical/CODEMAP.md to understand what is currently documented.

3. Scan the codebase

Run the following to get the current structure:

# Top-level src/ structure
find src/ -type f -name "*.ts" -o -name "*.tsx" -o -name "*.js" -o -name "*.jsx" -o -name "*.py" -o -name "*.go" 2>/dev/null | sort | head -100

# API routes / handlers
grep -r "router\.\|app\.\|@Get\|@Post\|@Put\|@Delete\|@Patch" src/ --include="*.ts" --include="*.js" --include="*.py" -l 2>/dev/null

# Exported utilities
grep -r "^export function\|^export const\|^def \|^func " src/ --include="*.ts" --include="*.js" --include="*.py" --include="*.go" -l 2>/dev/null | head -30

Also read docs/technical/API.md and docs/technical/DATABASE.md if they exist — they contain authoritative specs for the API and schema sections.

4. Update CODEMAP sections

For each section in CODEMAP.md, update the table rows to reflect what actually exists:

  • Application Modules: One row per top-level module/feature directory in src/
  • API Endpoints: One row per route group (not every individual endpoint — use route prefixes)
  • Shared Utilities: One row per utility file or helper module
  • Data Models: One row per major entity/table
  • External Integrations: One row per third-party service

Rules:

  • Remove rows for modules/files that no longer exist
  • Add rows for new modules/files
  • Keep descriptions concise — one sentence max
  • If a section has no entries yet, keep the *(not yet populated)* placeholder row
  • Do not over-document — only include modules that other agents would need to find

5. Update Revision History

Append a row to the Revision History table:

| [today's date] | @lead-programmer (or @technical-director) | [brief summary: "added X module, removed Y, updated API section"] |

6. Confirm

Print:

CODEMAP updated. [N] modules documented across [M] sections.
Stale entries removed: [list or "none"]
New entries added: [list or "none"]

Staleness indicators

CODEMAP should be re-run when:

  • A new feature directory is added to src/
  • An existing module is renamed, moved, or deleted
  • New API route groups are added
  • New third-party integrations are wired in
  • An agent says "I couldn't find X" when X should exist

Tip: After running /orchestrate on a large feature, run /update-codemap as the final step before closing the feature branch.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.