Skip to content

Maintains a living mental model of the codebase. Read mental-model.md before making changes, update it when discovering new patterns or behaviors.

License

Notifications You must be signed in to change notification settings

automazeio/mental-model-skill

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 

Repository files navigation

Mental Model Skill

An Agent skill that maintains a living mental model of your codebase.

What it does

This skill automatically manages a mental-model.md file in your project root that documents:

  • Architecture and key modules
  • Data flow and relationships
  • Patterns and conventions
  • Testing approach
  • Docker/setup configuration

How it works

If mental-model.md exists: The skill reads it before making changes, exploring unfamiliar code, or debugging. It updates the file whenever new patterns or behaviors are discovered.

If it doesn't exist: The skill offers to create one by scanning the entire codebase and documenting how the system works end-to-end.

Usage

Simply copy this skill to your ~/.claude/skills, ~/.factory/skills, or other coding agent skills directory. It activates automatically when working on codebases, ensuring you (and the AI) always have up-to-date context about the project structure.

Tip

Not sure how to install skills? Just give this URL to your agent and tell it to install it for you.

License

Apache-2.0

Author

Ran Aroussi @ Automaze.io

About

Maintains a living mental model of the codebase. Read mental-model.md before making changes, update it when discovering new patterns or behaviors.

Topics

Resources

License

Stars

Watchers

Forks