Project Inventory & Documentation
Analyze project folders to understand what each does, identify tech stacks, and create documented inventories.
Download this file and place it in your project folder to get started.
# Project Inventory & Documentation
## Your Role
You analyze project folders to understand what each project does, identify tech stacks, and create documented inventories for future reference.
## Inventory Structure
### Project Card Template
```markdown
## Project: [Project Name]
### Overview
**Purpose:** [What this project does]
**Status:** Active / Archived / In Progress / Abandoned
**Last Updated:** [Date]
**Location:** [Path]
### Tech Stack
| Layer | Technology |
|-------|------------|
| Frontend | [Framework] |
| Backend | [Language/Framework] |
| Database | [Database] |
| Hosting | [Platform] |
### Quick Stats
- Files: [Count]
- Lines of code: [Estimate]
- Dependencies: [Count]
- Last commit: [Date]
### Key Files
- Entry point: [file]
- Config: [file]
- README: [exists/missing]
### Notes
[Any important context or gotchas]
```
### Full Inventory Template
```markdown
# Project Inventory
## Summary
- Total projects: [Count]
- Active: [Count]
- Archived: [Count]
- Languages used: [List]
- Total disk space: [Size]
## Quick Reference
| Project | Type | Stack | Status | Last Active |
|---------|------|-------|--------|-------------|
| project-a | Web app | React/Node | Active | Jan 2025 |
| project-b | API | Python | Archived | Jun 2024 |
| project-c | CLI | Rust | Active | Jan 2025 |
## Detailed Inventory
[Individual project cards below]
```
## Analysis Checklist
### For Each Project
```markdown
## Project Analysis: [Name]
### Discovery
- [ ] Identify project type (web, api, cli, library, etc.)
- [ ] Find README or documentation
- [ ] Locate entry point
- [ ] Check for .env.example or config
### Tech Stack Detection
- [ ] Check package.json / requirements.txt / Cargo.toml
- [ ] Identify framework from code structure
- [ ] Note database connections
- [ ] Check deployment configs
### Status Assessment
- [ ] When was it last modified?
- [ ] Are dependencies current?
- [ ] Does it build/run?
- [ ] Is it deployed anywhere?
### Documentation Status
- [ ] README exists and is current
- [ ] Setup instructions present
- [ ] API documentation (if applicable)
- [ ] Comments in code
```
## Project Categories
```markdown
## Category Definitions
### By Type
- **Web Applications:** Frontend + backend
- **APIs:** Backend services
- **Libraries:** Reusable packages
- **CLI Tools:** Command-line utilities
- **Scripts:** One-off automation
- **Experiments:** Learning/testing
### By Status
- **Active:** Currently maintained
- **Stable:** Working, not actively developed
- **In Progress:** Under development
- **Archived:** No longer maintained
- **Abandoned:** Started but not finished
### By Visibility
- **Public:** Open source
- **Private:** Personal/work
- **Client:** Client work (note: check NDAs)
```
## Dependency Analysis
```markdown
## Cross-Project Dependencies
### Shared Libraries
| Library | Used By | Version Issues |
|---------|---------|----------------|
| lodash | proj-a, proj-b | None |
| react | proj-a, proj-c | Different versions |
### Shared Credentials
| Service | Used By | Location |
|---------|---------|----------|
| AWS | proj-a, proj-b | .env |
| Stripe | proj-c | config.json |
### Potential Conflicts
- [Project A] and [Project B] use different versions of [dependency]
```
## Health Report
```markdown
## Project Health Report
### Healthy ā
| Project | Last Updated | Notes |
|---------|--------------|-------|
| [Project] | [Date] | [Note] |
### Needs Attention ā ļø
| Project | Issue | Action Needed |
|---------|-------|---------------|
| [Project] | Outdated deps | Run npm update |
| [Project] | No README | Document |
### Archived/Cleanup šļø
| Project | Last Active | Recommendation |
|---------|-------------|----------------|
| [Project] | 2 years ago | Archive or delete |
```
## Instructions
1. Point me to your projects folder
2. I'll scan and analyze each project
3. Create inventory with tech stacks
4. Identify status and health
5. Generate documentation where missing
## Commands
```
"Analyze my projects in [folder]"
"What's this project for?" (in project directory)
"Create an inventory of all projects"
"Which projects use [technology]?"
"Find all abandoned projects"
"Generate README for this project"
```
## Maintenance Tips
1. **Review quarterly** - Update status and notes
2. **Archive old projects** - Don't delete, archive
3. **Document as you go** - Update on changes
4. **Track dependencies** - Note version requirements
5. **Back up important ones** - Especially client work
What This Does
Scans your projects folder to understand each project: what it does, tech stack used, status (active/archived), health metrics, and creates a documented inventory for future reference.
Prerequisites
- Claude Code installed
- Projects folder to analyze
- Interest in understanding your own work
Setup Instructions
Step 1: Download the Template
Download the CLAUDE.md template below and save it to your projects folder.
Step 2: Point to Your Projects
Identify what to analyze:
projects/
āāā project-a/
āāā project-b/
āāā old-stuff/
āāā experiments/
Step 3: Run Inventory
Start the analysis:
Analyze my projects folder and create an inventory
Example Usage
"What's this project for?" (in project directory)
"Which projects use React?"
"Find all abandoned projects"
"Generate README for this project"
"What's the health of my projects?"
What Gets Documented
- Purpose: What each project does
- Tech stack: Languages, frameworks, dependencies
- Status: Active, archived, abandoned
- Health: Last updated, dependency freshness
- Key files: Entry points, configs
Best Practices
- Review quarterly - Keep status current
- Archive properly - Don't delete, archive
- Document as you go - Update with changes
- Note dependencies - Version requirements matter