PROJECT.md Authoring Guide
Structure
PROJECT.md should contain:
- Project Overview - One-line description, tech stack
- Feature Registry - List of features with status (✅ complete, ⚠️ partial, ❌ not built)
- Test Status - Test coverage summary
- Development Info - Quick start, common tasks
- Post-MVP Roadmap - Future features (if any)
Guidelines
- Remove meta-documentation about how to write PROJECT.md (that's what this skill is for)
- Focus on current state only - no historical information
- Keep it scannable with headers, lists, and status emojis
- Link to detailed docs when needed (don't duplicate)
- Update feature registry when features are added/completed
- Remove features that are no longer relevant
Example Format
# Project Name
One-line description. Tech stack.
## Feature Registry
### Core Features
- ✅ Feature 1 - Brief description
- ✅ Feature 2 - Brief description
- ❌ Feature 3 - Not yet implemented
### Test Status
- ✅ Integration tests (input→output)
- ❌ E2E tests (not needed yet)
## Development
Quick start commands...
## Post-MVP Roadmap
Future features...
Converted and distributed by TomeVault — claim your Tome and manage your conversions.