blackbenjaminblackbenjamin/etps/.claude/skills/project-documentation/SKILL.md

project-documentation

Skill1 starsChanged 11 months agoMITView on GitHub

Update and maintain project documentation including CLAUDE.md, API docs, architecture docs, and data model specs. Use when updating docs, documenting features, or after completing sprints.

5 other projects use a version of this.

Adopted by

Most recently taken up by

SWEStash/swe-workflow-skillstheir own version, first seen Nov 8, 2026
Garfield247/agent-skill-project-documentationtheir own version, first seen Oct 22, 2026
NAVANEETHVVINOD/agent-orchestratortheir own version, first seen Oct 3, 2026
realtrung/AGENTS.mdtheir own version, first seen Jul 11, 2026
wpank/aitheir own version, first seen Feb 10, 2026

Other versions5 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 5
wpank/ai★ 11same name
realtrung/AGENTS.md★ 2same name
SWEStash/swe-workflow-skills★ 1same name
Garfield247/agent-skill-project-documentation★ 0same name
NAVANEETHVVINOD/agent-orchestrator★ 0same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository7 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- fastapi-backendSkill
- llm-integrationSkill
- nextjs-frontendSkill
- python-testingSkill
- security-reviewSkill
- sqlalchemy-databaseSkill

The file

Show its rules and text

We split this skill into the rules it gives an agent

13 rules. 0 are common, 11 are distinctive, and 2 are very specific to this project.

0
Common
Most of the 4 edited versions we read keep these.
11
Distinctive
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Distinctive:
Update phase status (COMPLETE/IN PROGRESS)
line 23
Distinctive:
Add new fields with types
line 29
Distinctive:
Update JSON schema examples
line 31
Distinctive:
Add to service map diagram
line 36
Distinctive:
Add to API endpoints table
line 38
Very specific:
Use backticks for code and file_paths
line 57
Distinctive:
Use code blocks with language tags
line 58
Distinctive:
Use tables for structured data
line 59
Distinctive:
Keep line length reasonable (~80 chars)
line 60
Distinctive:
Update docs immediately after changes
line 64
Very specific:
Keep IMPLEMENTATION_PLAN.md current
line 65
Distinctive:
Document all schema changes
line 66
Distinctive:
Commit docs with related code changes
line 68

“Common” is measured: kept by at least 6 in 10 of the 4 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.

Files

SKILL.md

ETPS Documentation Management

Key Documents

Document	Purpose	Update When
`CLAUDE.md`	Project config for Claude Code	Workflows change
`ETPS_PRD.md`	Product Requirements (source of truth)	Requirements change
`docs/IMPLEMENTATION_PLAN.md`	Sprint roadmap	Sprint completes
`docs/ARCHITECTURE.md`	System architecture	Services added
`docs/DATA_MODEL.md`	Database schema	Models change
`docs/cover_letter_style_guide.md`	AI writing rules	Style rules change

Update Triggers

After Completing a Sprint

Update docs/IMPLEMENTATION_PLAN.md:

Mark completed tasks with [x]
Update phase status (COMPLETE/IN PROGRESS)
Update test count
Note any blockers or changes

After Changing Database Models

Update docs/DATA_MODEL.md:

Add new fields with types
Update relationships diagram
Update JSON schema examples
Increment version (e.g., v1.4.2 -> v1.4.3)

After Adding Services

Update docs/ARCHITECTURE.md:

Add to service map diagram
Document inputs/outputs
Add to API endpoints table

Version Numbering

Major.Minor.Patch
  │     │     └── Documentation clarifications
  │     └──────── New fields/entities
  └────────────── Breaking schema changes

Current Status

Phase 1A-1C: COMPLETE (Sprints 1-14)
Live URLs:
- Frontend: https://etps.benjaminblack.consulting
- Backend: https://etps-production.up.railway.app
Tests: 700+ passing
Next: Phase 2 (Sprints 15-17) - Company Intelligence

Documentation Style

Use backticks for code and file_paths
Use code blocks with language tags
Use tables for structured data
Keep line length reasonable (~80 chars)
Link between related documents

Best Practices

Update docs immediately after changes
Keep IMPLEMENTATION_PLAN.md current
Document all schema changes
Include examples in technical docs
Commit docs with related code changes

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

It worked
Partly
It didn't

What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free