docs-components-design

docs-components-design is a skill for Codex from onatm/agent-skills. It costs 39 tokens per session (567 once invoked), scanned A, original, MIT.

A set of instructions for keeping technical design documents up to date for services, workers, modules, integrations, and APIs. These documents describe how a software component works and connects to other parts.

In plain words
What is it for?
Use it when adding or changing a service, worker, module, API, shared component, integration, queue, schema, or runtime behavior.
Why use it?
It keeps implementation details such as interfaces, data shapes, retries, failures, and security boundaries in one consistent place.

Skill for Codex

Written for Codex: agents/openai.yaml present.

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.

agentmods
npx agentmods add skills/onatm/agent-skills/docs-components-design
Any agent
npx skills add onatm/agent-skills --skill docs-components-design
Clone the repo
git clone --depth 1 https://github.com/onatm/agent-skills

Made for: 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 docs-components-design

README.md
[![agentmods](https://agentmods.dev/badge/skills/onatm/agent-skills/docs-components-design.svg)](https://agentmods.dev/skills/onatm/agent-skills/docs-components-design)
Your own site
<a href="https://agentmods.dev/skills/onatm/agent-skills/docs-components-design"><img src="https://agentmods.dev/badge/skills/onatm/agent-skills/docs-components-design.svg" alt="Measured on agentmods" height="20"></a>
Per session 39 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 567 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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.00039 $0.00567
Opus 5 $0.00019 $0.00283
Sonnet 5 $0.00008 $0.00113
Haiku 4.5 $0.00004 $0.00057

Measured 5d ago against content hash 8b6e0029e30f, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

docs-components-design 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 5d 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.

docs-components-design/SKILL.md · 67 lines

How it starts

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

Docs Components Design

Maintain technical design docs for implementation units. Put contracts, state, runtime behavior, and operational detail here rather than in feature or architecture docs.

Resource Map

  • Use assets/doc-starters/component-design-doc.md when creating or substantially rewriting a doc in docs/designs/.
  • Read references/component-design-example.md when you need a worked example of the expected technical depth.

When to Use

  • New service, worker, module, integration surface, or shared component
  • Changes to interfaces, contracts, schema, queues, state machines, or external integrations
  • Changes to concurrency, retries, failure handling, security boundaries, or operational behavior
  • Technical design updates that should not live in feature docs

Do Not Use

  • System or domain topology docs that belong in docs-architecture
  • User-facing feature behavior and goals that belong in docs-feature-design

Workflow

  1. Identify the implementation unit and current doc path.
  • Default location is docs/designs/
  • Reuse an existing design doc when one already exists
  1. Capture the technical shape of the change.
  • Problem and scope
  • Interfaces and contracts
  • Data model or state changes
  • Runtime behavior, failure modes, and operations
  • Security and ownership boundaries
  1. Keep feature and architecture boundaries clean.
  • Link to relevant feature docs instead of retelling the product story
  • Link to architecture docs instead of restating system topology
  1. Verify against the repo.
  • Commands, migrations, contracts, and runtime behavior match the current code
  • Design decisions still reflect the active implementation
  1. Trim low-value detail.
  • Avoid path dumps and copied code
  • Keep only the technical detail needed to understand and maintain the component

Writing Rules

  • Technical detail belongs here
  • Prefer concise summaries of contracts, schemas, and state over long pasted definitions
  • If one component supports multiple features, describe the reusable implementation capability rather than a single feature narrative
  • Make trade-offs, failure modes, and ownership explicit
  • The Technical Design sub-sections (Interfaces, Data Model, Runtime, Security) are a baseline — add domain-specific sections (Processing Flow, Algorithm, Examples, Configuration) at the same level when they clarify the design better than generic sub-sections would

Read the full file on GitHub · 67 lines

Files

What ships with it

3 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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. 5d ago First seen · 67 lines · 39 tokens per session scan A 8b6e0029e30f

Subscribe to this mod's changes

docs-components-design is a skill published in the GitHub repository onatm/agent-skills (7 stars, last pushed 1mo ago), licensed MIT. It adds 39 tokens to every session and 567 once invoked, about $0.0002 per session on Opus 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-08-31.

Related

Other skills, from other repositories

workers-best-practices

Reviews and authors Cloudflare Workers code against production best practices. Load when writing new Workers, reviewing Worker code, configuring wrangler.jsonc, or checking for common Workers anti-patterns (streaming, floating promises, global state, secrets, bindings, observability). Biases towards retrieval from…

cloudflare/skills · 72 tokens

find-journalists

Build, refine, dedupe, and enrich small fit-checked journalist lists for newsjack campaigns. Uses the newsjack CLI (preferred) or the medialyst MCP for news search and journalist enrichment, and falls back to a best-effort local mode with no verified contacts; the agent owns how returned data is organized.

elvisun/newsjack · 69 tokens

story-origin-check

Recover the first public timestamp and canonical major coverage for a newsjacking signal, then decide whether newer coverage is the same story, a different story, or a materially new development.

elvisun/newsjack · 40 tokens

relevance-coarse-filter

Cheap, high-recall first-pass filter that removes obvious junk from a detector candidate pool before expensive story-origin research and PR judgment. Decides keep, monitoronly, or reject — never ranks, writes angles, verifies dates, or decides whether to pitch.

elvisun/newsjack · 57 tokens

annotating-task-lineage

Annotate Airflow tasks with data lineage using inlets and outlets. Use when the user wants to add lineage metadata to tasks, specify input/output datasets, or enable lineage tracking for operators without built-in OpenLineage extraction.

astronomer/agents · 51 tokens

managing-astro-local-env

Manage local Airflow environment with Astro CLI (Docker and standalone modes). Use when the user wants to start, stop, or restart Airflow, view logs, query the Airflow API, troubleshoot, or fix environment issues. For project setup, see setting-up-astro-project.

astronomer/agents · 63 tokens