# Write Project File

> Create or update PROJECT.md files for this repo. Use when authoring or maintaining PROJECT.md. Use when this capability is needed.

- Skill: `tomevault-io/write-project-file` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/write-project-file`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/write-project-file/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/write-project-file

---


# PROJECT.md Authoring Guide

## Structure

PROJECT.md should contain:
1. **Project Overview** - One-line description, tech stack
2. **Feature Registry** - List of features with status (✅ complete, ⚠️ partial, ❌ not built)
3. **Test Status** - Test coverage summary
4. **Development Info** - Quick start, common tasks
5. **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

```markdown
# 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](https://tomevault.io/claim/joernstoehler) — claim your Tome and manage your conversions.
<!-- tomevault:4.0:skill_md:2026-04-16 -->