Guide · Agent skill
How to use the Write Architecture Docs agent skill
Updated · written with AI from the project's own documentation and checked against our catalogue data
The write-architecture-docs skill is a set of house rules that an AI agent follows when it writes or reviews internal architecture documentation in the Prisma repo, such as subsystem docs and ADRs under docs/architecture docs/. This guide explains what the skill changes about the agent's behaviour, how to install it, how to trigger it with plain requests, and what to check before you rely on it. You do not need prior experience with agent skills to follow it.
Quick start
- 1Download the ZIP. Get the write-architecture-docs ZIP from this skill's page in the directory.
- 2Unzip into a skills folder. Extract it into ~/.claude/skills/ for personal use, or into a project's .claude/skills/ folder to limit it to that project.
- 3Or upload it in the Claude apps. In the Claude apps, open Settings → Capabilities → Skills and upload the ZIP.
- 4Make a natural request. Ask for a doc or review under docs/architecture docs/ in plain language, naming the subsystem or ADR involved.
- 5Review the draft. Check the result for project-status wording, a leading code example, inline ADR summaries and a newcomer-friendly overview before publishing.
What an agent skill is and what this one makes the agent do
An agent skill is a folder containing a SKILL.md file with instructions that an AI agent can load when a task matches the skill's description. The agent reads those instructions and follows them while working on your request.
This skill is a writing guide, not a tool that changes the system. Once it is loaded, the agent reads at least two sibling docs in the same directory to match their voice, structure and level of detail. It reads the ADRs it plans to reference and summarises their key idea inline, so readers do not have to follow the link to understand the doc.
- Leads with a concrete, complete code snippet, JSON example or diagram near the top of the document.
- Explains why before what, and uses concrete examples.
- Describes the system rather than the project, and avoids words such as PoC, sprint, workstream, milestone and current effort.
- Avoids comparisons with other products or prior versions.
- Orders references: ADRs first, durable reference material second, historical planning docs last and labelled as such.
Install the write-architecture-docs skill
Download the ZIP from the skill's page in this directory, then unzip it. You can install it in one of three places depending on how you use the agent.
For a personal setup available across your projects, unzip the skill into ~/.claude/skills/. To limit it to one project, unzip it into that project's .claude/skills/ folder. You can also upload the ZIP in the Claude apps under Settings → Capabilities → Skills.
- Personal: ~/.claude/skills/
- Single project: .claude/skills/ inside the project folder
- Claude apps: Settings → Capabilities → Skills, then upload the ZIP
Trigger the skill with natural requests
You do not need a special command. The skill's description tells the agent when to use it: creating, updating or reviewing docs under docs/architecture docs/, or when you ask for documentation that describes the system's design. Ask in plain language and name the file or subsystem where possible.
Because the skill also tells the agent to read sibling docs first, a request that names a directory gives it better context to match.
- Write an architecture doc for the migration subsystem under docs/architecture docs/subsystems/.
- Review this ADR summary and rewrite it so a new engineer can follow it without the link.
- Update the execution pipeline doc to remove the project-status wording.
- Draft a subsystem overview for the contract layer, starting with a grounding example.
Examples of what the output looks like
The skill shapes the document's form. Suppose you ask for an overview of a subsystem. The agent will open with plain language about what the part of the system is and why it exists, then place a concrete snippet near the top with short callouts that point out the key ideas.
When it cites an ADR, the text carries the key idea in a sentence or two and then links the ADR for depth. The rules also ask the agent to state facts about the system rather than narrate how the team got there, so a sentence such as 'The pipeline generalizes across families' is preferred over 'The PoC validated that the pipeline generalizes'.
What it needs, and safety notes
The listing shows no required dependencies. The skill runs no scripts and uses no network access. The only file in the package is SKILL.md, so installing it adds instructions and nothing that executes on your machine.
The skill is written for the Prisma repo. It assumes its folder layout (docs/architecture docs/) and its ADR conventions, so it will fit poorly in other projects. It is also not meant for user-facing Prisma tutorials or marketing copy, because its rules target internal engineering reference docs.
- Requires: nothing listed
- Runs scripts: no
- Uses network: no
- Files: SKILL.md
Tips for getting good results
Give the agent the path to the docs it should match before it starts writing. The skill asks for two sibling docs to be read, so pointing it at a directory saves you a correction round.
Review the output against the skill's quality check: can a newcomer understand each paragraph without outside context, does it explain why before what, and is a concrete example present. Edit any project-status wording the agent misses.
- Name the subsystem directory and any ADRs you want referenced.
- Ask for a grounding example if the draft opens with abstract prose.
- Check that every ADR link resolves from the subsystem doc's location.
What people use it for
- Drafting a new subsystem doc under docs/architecture docs/subsystems/ that matches the tone of existing docs.
- Rewriting an existing architecture doc to remove sprint, PoC or milestone language.
- Writing an ADR-aware section that summarises linked decisions inline.
- Reviewing a maintainer's draft for consistent structure across subsystem docs and ADRs.
Frequently asked questions
Is the write-architecture-docs skill free to use?
The skill is published under the Apache-2.0 licence, as listed on its page. Check the licence file in the repository for the full terms before reusing or redistributing it.
What do I need installed to use write-architecture-docs?
The listing says it requires nothing. It runs no scripts and uses no network, and the package contains only SKILL.md. You need an agent environment that supports skills, either Claude Code with a skills folder or the Claude apps with Skills in Capabilities.
Where do I put the skill folder for Claude Code?
Unzip it into ~/.claude/skills/ to make it available in all your projects, or into the project's .claude/skills/ folder to make it available only there.
Why isn't my agent using the skill?
The skill loads when a request matches its description, which covers docs under docs/architecture docs/ or requests to document the system's design. Name that path or describe the design documentation task explicitly, and confirm the folder was unzipped into one of the skills locations.
Can I use this skill for user-facing Prisma tutorials or other projects?
The skill is not designed for that. Its rules target internal engineering reference docs, and it assumes the Prisma repo's folder layout and ADR conventions. The listing advises against using it for user-facing tutorials, marketing copy or projects outside this repo.
Does the skill change my code or run commands?
No. It is a writing guide that shapes how the agent writes documentation. It runs no scripts and makes no network calls, according to the listing.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
Use this skill if you are an engineer on the Prisma team or a maintainer writing or reviewing internal architecture docs and ADRs, and you want consistent style across them. Pick something else if you need user-facing tutorials, marketing copy, or guidance for a project with a different folder layout and ADR convention.
Download the skill