Write Architecture Docs
Write clear, self-contained architecture docs and ADR summaries for the Prisma codebase
- Repository
- prisma/orm
- Stars
- 47,663
- Licence
- Apache-2.0
- Files
- 1 file
What it does
When installed, the agent follows a set of house rules for writing internal architecture documentation in the Prisma repo. Before writing, it reads sibling docs to match tone and structure, summarises referenced decision records inline, leads with a concrete code example, and avoids project-status language like 'PoC' or 'sprint'. It is a writing guide, not a tool that changes the system.
Great for
- Engineers on the Prisma team writing or reviewing docs under docs/architecture docs/
- Maintainers who want consistent style across subsystem docs and ADRs
Skip it if
- Writing user-facing Prisma tutorials or marketing copy, because the rules target internal engineering reference docs
- Projects outside this repo, since it assumes its folder layout and ADR conventions
Try asking
- “Write a new subsystem doc for the query execution pipeline under docs/architecture docs/subsystems/”
- “Review this architecture doc and tell me where it uses project-process language or jargon without explanation”
- “Rewrite this section so it leads with a grounding example and links ADR 177 with an inline summary”
Install in 3 steps
- 1
Download the skill
The ZIP contains the 1 original files, the Apache-2.0 licence and an attribution note.
write-architecture-docs.zip - 2
Add it to your agent
Claude Code (all projects)
mkdir -p ~/.claude/skills && unzip write-architecture-docs.zip -d ~/.claude/skills/Claude Code / Agent SDK (this project only)
mkdir -p .claude/skills && unzip write-architecture-docs.zip -d .claude/skills/Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.
- 3
Ask for the task
No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.
Get better results
- Point the agent at the target directory so it can read two sibling docs first, as the skill instructs.
- Ask for a review pass as well as drafting; the quality checklist works well as a self-critique step.
- Check that any ADR paths and links the agent produces actually exist in your repo.
What's inside
- SKILL.md
Redistributed unmodified from prisma/orm under the Apache-2.0 licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.