Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions PROJECTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,20 +81,24 @@ When adding a new project, include:
**Description**: Brief overview of what this project is and its purpose.

**Technologies**:

- List main technologies, frameworks, languages

**Goals**:

- Primary objectives and success criteria

**Current Status**:

- What's working
- What's in progress
- Any blockers

**Links**:
- [Repository](#)
- [Documentation](#)
- [Live Demo](#) _(if applicable)_

- Repository: (link here)
- Documentation: (link here)
- Live Demo: (link here if applicable)

**Related Projects**: References to related work

Expand Down Expand Up @@ -158,4 +162,5 @@ Common tags used in tags.json:

---

**Note**: Run `./scripts/update-project-list.sh` to auto-generate project summaries from filesystem and tags.json.
**Note**: Run `./scripts/update-project-list.sh` to auto-generate
project summaries from filesystem and tags.json.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@ A centralized repository for tracking all my work, projects, and learning activi
## Purpose

This repository serves as:

- **Project Portfolio**: Showcase of completed and ongoing work
- **Work Tracker**: Organized documentation of development progress
- **Learning Log**: Record of experiments, courses, and technical growth
- **Knowledge Base**: Centralized documentation and resources

## Repository Structure

```
```text
Projects/
├── active/ # Currently active projects
├── completed/ # Finished projects
Expand Down Expand Up @@ -44,17 +45,20 @@ Projects/
The `project-docs/` submodule provides Claude Code commands for maintaining documentation:

**Installation** (if not already installed):

```bash
claude plugins add teresa-torres-plugins/project-docs
```

**Key Commands**:

- `/project-docs:readme` - Update project README with setup/usage info
- `/project-docs:architecture` - Document system design and patterns
- `/project-docs:process-notes` - Log work history and decisions
- `/project-docs:ab-test <name>` - Document A/B tests and experiments

**When to Use**:

- Start of each work session: Review existing docs
- During development: Log key decisions and blockers
- End of session: Update process-notes with progress
Expand All @@ -71,23 +75,29 @@ claude plugins add teresa-torres-plugins/project-docs
## Project Categories

### Active Projects

Currently under development with regular updates.

### Completed Projects

Finished projects that are deployed or delivered.

### Experiments

Quick proofs-of-concept, spikes, and technical explorations.

### Learning

Tutorial projects, course work, and skill development.

### Archived

Deprecated, paused, or superseded projects kept for reference.

## Documentation Standards

Each project should include:

- `README.md` - What it is, how to use it, setup instructions
- `ARCHITECTURE.md` - Design decisions, patterns, system overview
- `process-notes.md` - Development history and decisions (gitignored)
Expand All @@ -111,6 +121,7 @@ Each project should include:
## Resources

See `resources/` directory for:

- Curated bookmarks and articles
- Course materials and notes
- Technical references
Expand All @@ -119,6 +130,7 @@ See `resources/` directory for:
## Tools & Scripts

The `scripts/` directory contains utilities for:

- Scaffolding new projects
- Generating project summaries
- Archiving completed work
Expand All @@ -130,10 +142,6 @@ Run `./scripts/new-project.sh --help` for usage information.

For current project status and statistics, see [PROJECTS.md](./PROJECTS.md).

## License

See [LICENSE](./LICENSE) for details.

---

**Last Updated**: 2026-01-09
36 changes: 35 additions & 1 deletion WORKFLOW.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,11 @@ This document outlines my personal workflow for managing projects in this reposi
- `learning/` - Tutorial or learning exercise

2. **Create Structure**

```bash
./scripts/new-project.sh <category> <project-name>
```

Or manually:
- Create project directory
- Copy templates from `templates/`
Expand Down Expand Up @@ -121,9 +123,11 @@ This document outlines my personal workflow for managing projects in this reposi
- Tag final version

3. **Move to Completed**

```bash
./scripts/archive-project.sh <project-name> completed
```

Or manually:
- Move from `active/` to `completed/`
- Update `PROJECTS.md` status
Expand All @@ -145,6 +149,7 @@ For projects that are paused, deprecated, or no longer relevant:
```

Or manually:

- Move to `archived/` directory
- Update `PROJECTS.md` with reason for archiving
- Update `tags.json` status
Expand All @@ -153,30 +158,35 @@ Or manually:
## Naming Conventions

### Projects

- Use `kebab-case-names`
- Be descriptive but concise
- Include tech stack if ambiguous: `python-data-analyzer`
- Include purpose if needed: `learning-rust-basics`

### Git Branches

- `feature/add-authentication`
- `fix/memory-leak-in-parser`
- `experiment/try-new-algorithm`
- `docs/update-architecture`

### Git Commits

- Use imperative mood: "Add feature" not "Added feature"
- Start with verb: Add, Update, Fix, Remove, Refactor
- Keep first line under 72 characters
- Add details in body if needed

Examples:

- `Add user authentication with JWT`
- `Fix memory leak in data parser`
- `Update README with installation instructions`
- `Refactor database queries for performance`

### Files

- `README.md` - Project overview and usage
- `ARCHITECTURE.md` - Design and technical details
- `process-notes.md` - Work log (gitignored)
Expand All @@ -188,15 +198,19 @@ Examples:
### When to Use Each Command

#### `/project-docs:readme`

Use when:

- Starting a new project
- Adding user-facing features
- Changing setup/installation process
- Modifying deployment procedures
- Adding configuration options

#### `/project-docs:architecture`

Use when:

- Designing initial system architecture
- Adding new infrastructure components
- Establishing new patterns or conventions
Expand All @@ -205,7 +219,9 @@ Use when:
- Making architectural decisions

#### `/project-docs:process-notes`

Use when:

- End of work session
- Context window approaching limit (~90%)
- Completing a major feature or milestone
Expand All @@ -215,7 +231,9 @@ Use when:
- Learning something significant

#### `/project-docs:ab-test`

Use when:

- Planning experiments or comparisons
- Testing multiple approaches
- Measuring feature impact
Expand All @@ -224,7 +242,9 @@ Use when:
### Agent Usage

#### `/project-docs:plan-review`

Use before implementing complex features:

- After creating implementation plan
- Before writing significant code
- To check consistency with ARCHITECTURE.md
Expand All @@ -235,6 +255,7 @@ Use before implementing complex features:
### tags.json Structure

Keep `tags.json` updated with:

- Project name and location
- Current status (active, completed, archived, paused)
- Technology tags
Expand All @@ -243,6 +264,7 @@ Keep `tags.json` updated with:
- Related projects

Update when:

- Creating new project
- Changing project status
- Moving project directories
Expand All @@ -251,57 +273,69 @@ Update when:
## Tools and Scripts

### new-project.sh

Creates new project with template files:

```bash
./scripts/new-project.sh <category> <project-name>
```

### archive-project.sh

Moves project to completed or archived:

```bash
./scripts/archive-project.sh <project-name> <destination>
```

### update-project-list.sh

Regenerates project summaries in PROJECTS.md:

```bash
./scripts/update-project-list.sh
```

## Tips and Best Practices

### Documentation

- Write for your future self - you'll forget context
- Document the "why" not just the "what"
- Capture dead ends to avoid repeating mistakes
- Keep docs close to code they describe

### Git Practices

- Commit before trying risky changes
- One logical change per commit
- Write commit messages that explain why
- Push regularly for backup

### Context Management

- Save important details before they scroll away
- Use process-notes proactively, not reactively
- Include file paths in notes for easy navigation
- Link related decisions together

### Project Organization

- Start simple, add structure as needed
- Prefer real organization over metadata
- Keep related things together
- Archive liberally - disk space is cheap

### Learning Projects

- Document learnings as you go
- Compare with previous approaches
- Note resources and references
- Extract reusable patterns

---

**Note**: This workflow is a living document. Update it as practices evolve and new patterns emerge.
**Note**: This workflow is a living document. Update it as practices
evolve and new patterns emerge.

**Last Updated**: 2026-01-09
Loading