write-architecture-docs

write-architecture-docs is a skill for Claude Code, Codex from prisma/orm. It costs 55 tokens per session (1,329 once invoked), scanned A, original, Apache-2.0.

A guide for writing documentation about a software system's architecture, including subsystem descriptions and architecture decision records. It is aimed at engineering teams that need both context and precise technical reference.

In plain words
What is it for?
Use it to create, rewrite, or review architecture documentation and ADRs in an engineering repository.
Why use it?
It helps architecture documents stay understandable to people without prior project knowledge while preserving useful technical detail. This creates a more consistent record of how the system is designed.

Skill for Claude CodeCodex ✓ vendor

Written for no agent in particular: nothing here depends on one.

Good fit Use it to create, rewrite, or review architecture documentation and ADRs in an engineering repository.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/prisma/orm/write-architecture-docs
About the project

Prisma ORM is a Node.js and TypeScript database toolkit that lets applications work with databases through a programming interface instead of writing every query directly in SQL. Developers use it with databases including PostgreSQL, MySQL, MariaDB, SQL Server, SQLite, MongoDB, and CockroachDB. The catalogue add-ons provide agent rules, skills, hooks, agents, and other workflows for using Prisma.

prisma/orm · 47,697 stars · on GitHub · prisma.io

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add prisma/orm --skill write-architecture-docs
Clone the repo
git clone --depth 1 https://github.com/prisma/orm

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for write-architecture-docs

README.md
[![agentmods](https://agentmods.dev/badge/skills/prisma/orm/write-architecture-docs/github.svg)](https://agentmods.dev/skills/prisma/orm/write-architecture-docs)
Your own site
<a href="https://agentmods.dev/skills/prisma/orm/write-architecture-docs"><img src="https://agentmods.dev/badge/skills/prisma/orm/write-architecture-docs/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for write-architecture-docs

Your own site · 80×15
<a href="https://agentmods.dev/skills/prisma/orm/write-architecture-docs"><img src="https://agentmods.dev/badge/skills/prisma/orm/write-architecture-docs.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 55 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,329 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe. Third-party audits
  • Snyk pass 7 Sept 2026
  • NVIDIA SkillSpector pass 7 Sept 2026
How audits are shown
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00055 $0.01329
Opus 5.5 $0.00022 $0.00532
Sonnet 5.5 $0.00011 $0.00266
Haiku 4.5 $0.00006 $0.00133

Measured 1mo ago against content hash afd6cdf56230, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

write-architecture-docs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 1mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

skills-contrib/write-architecture-docs/SKILL.md · 73 lines

How it starts

The opening of the file, as written. The whole thing — 73 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Writing Architecture Documentation

Architecture docs in this repo serve two audiences: team members working on the system (need precise reference material) and team members seeking context (need an accessible narrative). The doc must work for both without requiring prior project context.

Before writing

  1. Read at least two sibling docs in the same directory (e.g., other subsystem docs under docs/architecture docs/subsystems/). Calibrate your voice, structure, and level of detail to match them.
  2. Read the ADRs you'll reference. Don't just link to them — understand them well enough to summarize the key idea inline, so the reader doesn't have to follow the link to understand the doc.

Voice and framing

Write about the system, not the project. These docs describe the intended system as far as we know it. They are not project retrospectives, sprint summaries, or PoC reports.

  • State facts: "The execution pipeline generalizes across families" — not "The PoC validated that the execution pipeline generalizes"
  • No transient project references: avoid "workstream", "PoC", "sprint", "milestone", "being validated", "current effort"
  • No product comparisons: don't reference other products or prior versions. Describe what the system is, not what it improves upon.
  • Non-goals are architectural boundaries, not "not yet done" items. No (current) qualifiers.

Write for a developer without prior context. Imagine someone joining the team and reading this doc as their first exposure to this part of the system.

  • Explain why before what. Before introducing a concept like model ownership, explain the problem it solves: "In SQL, related data lives in separate tables and is joined at query time. In MongoDB, the idiomatic pattern is to store related data inside the parent document."
  • Let ideas breathe. Don't compress three concepts into one sentence. If a sentence requires the reader to already understand three things to parse it, break it apart.
  • Use concrete examples — code snippets, JSON fragments, "a developer writing X gets Y under the hood." Abstract descriptions are hard to pin understanding to.

Read the full file on GitHub · 73 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 1mo ago First seen · 73 lines · 55 tokens per session scan A afd6cdf56230

Subscribe to this mod's changes

write-architecture-docs is a skill published in the GitHub repository prisma/orm (47,697 stars, last pushed today), licensed Apache-2.0. It adds 55 tokens to every session and 1,329 once invoked, about $0.0002 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-03.

Related

Other skills, from other repositories

prisma-orm

Use when modeling data or writing type-safe queries with Prisma ORM in TypeScript — schema.prisma, prisma.config.ts, the generated Prisma Client, and Prisma Migrate, including the v6 to v7 upgrade. NOT schema-as-TS with a SQL builder (that is drizzle-orm), NOT ORM-agnostic zero-downtime migration (that is…

ericrisco/rsc-harness · 101 tokens

build-with-tinybase

Scaffold, extend, and verify reactive local-first JavaScript or TypeScript applications with TinyBase. Use when choosing TinyBase for in-memory tabular or key-value state, generating an app with create-tinybase, adding schemas or UI bindings, resolving TinyBase import paths, configuring browser or database…

tinyplex/tinybase · 90 tokens

output-dev-credentials

Store and reference encrypted secrets in Output SDK workflows using @outputai/core/credentials. Use when integrating API keys, database passwords, or third-party tokens.

growthxai/output · 36 tokens

better-drizzle

Write, review, and debug code that uses better-drizzle, the typed repository layer over Drizzle ORM 1.x (better(db), db.users.findMany, paginate, cursor, upsertMany, relation include/connect, transactions, and the rules/zod/soft-delete/timestamps/uuid/cache/tenant plugins). Use when a project imports better-drizzle…

almeidazs/better-drizzle · 106 tokens

monitoring-ingestion-pipeline

Guide for using the Grafana MCP to monitor and diagnose the Node.js ingestion pipeline workers in production. Use when investigating event lag, drops, pipeline errors, person/group processing, Kafka consumer health, Redis, Postgres, ClickHouse downstream health, or any ingestion worker question. Covers prod-us and…

PostHog/posthog · 71 tokens

django-migrations

Django migration patterns and safety workflow for PostHog. Use when creating, adjusting, or reviewing Django/Postgres migrations, including non-blocking index/constraint changes, multi-phase schema changes, data backfills, migration conflict rebasing, and product model moves that require SeparateDatabaseAndState. Also…

PostHog/posthog · 99 tokens