project-overview

A documentation workflow for creating project overview documents for major software projects or features. These documents record the project’s purpose, background, goals, timeline, and important architecture decisions.

In plain words
What is it for?
Use it when starting multi-week projects, making major architecture changes, coordinating across teams, or documenting prototypes that may become production work.
Why use it?
It gives team members and future contributors the context they need without relying on scattered conversations or tribal knowledge. It is intended for substantial work, not small fixes or routine maintenance.

Skill for Claude CodeCodex

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/markerikson/opencode-config-example/project-overview
Any agent
npx skills add markerikson/opencode-config-example --skill project-overview
Clone the repo
git clone --depth 1 https://github.com/markerikson/opencode-config-example

Made for: Claude Code, Codex.

Per session 41 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,391 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 $0.00041 $0.01391
Opus 5 $0.00020 $0.00696
Sonnet 5 $0.00008 $0.00278
Haiku 4.5 $0.00004 $0.00139

Measured 2d ago against content hash eabb86c3efe2, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

project-overview 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 2d 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.

config/skill/project-overview/SKILL.md · 261 lines

How it starts

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

Project Overview Skill

Create comprehensive project overview documents that provide strategic context and understanding for major projects or features.

When to Use This Skill

  • Starting a major project (multi-week effort)
  • Significant architectural changes
  • Cross-team initiatives needing shared context
  • Prototypes that will inform production work
  • Dogfooding/validation projects

Don't use for:

  • Small bug fixes
  • Single-feature additions
  • Routine maintenance work

Document Template

Title and Metadata

# [Project Name]: Project Overview

**Project Name:** [Short identifier]
**Status:** [Planning / In Progress / Complete]
**Timeline:** [Estimated duration]
**Purpose:** [One-sentence summary]

---

Section 1: Understanding the Context

Provide background for someone unfamiliar with the project. Answer:

  • What is the system/codebase you're working in?
  • What prior work led to this? (prototypes, experiments, decisions)
  • What recent progress or decisions have been made?

Length: 3-5 paragraphs

Example:

## Understanding the Context

### What is [System Name]?
[Brief description of the system, its purpose, what it generates/does]

### The [Prototype/Reference Project]
[Describe any reference implementation or prototype that validated the approach]

### Recent Progress
[Key decisions or progress that led to this work]

Section 2: What is This Project?

Define the project scope clearly.

## What is This Project?

### Current State
[Describe what exists today and why it's insufficient]

### Target State
[Describe the desired end state]

### Important Scope Decisions
**In Scope:**
- [What you ARE doing]

**Out of Scope:**
- [What you are NOT doing - be explicit]

Critical: Use blockquotes or callouts for major scope constraints:

> **⚠️ SCOPE:** This focuses exclusively on [X]. We are NOT:
> - [Thing 1]
> - [Thing 2]

Section 3: Why This Work Matters

Explain the value. Don't assume it's obvious.

Read the full file on GitHub · 261 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. 2d ago First seen · 261 lines · 41 tokens per session scan A eabb86c3efe2

Subscribe to this mod's changes

project-overview is a skill published in the GitHub repository markerikson/opencode-config-example (44 stars, last pushed 3mo ago), licensed MIT. It adds 41 tokens to every session and 1,391 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-30.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 tokens

babysit-pr

Babysit a GitHub pull request after creation by continuously polling review comments, CI checks/workflow runs, and mergeability state until the PR is merged/closed or user help is required. Diagnose failures, retry likely flaky failures up to 3 times, auto-fix/push branch-related issues when appropriate, and keep…

openai/codex · 114 tokens

imagegen

Generate or edit raster images when the task benefits from AI-created bitmap visuals such as photos, illustrations, textures, sprites, mockups, or transparent-background cutouts. Use when Codex should create a brand-new image, transform an existing image, or derive visual variants from references, and the output…

openai/codex · 113 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens

next-cache-components-optimizer

Drive a Next.js route to instant navigation by setting up an agentic loop, under Cache Components / PPR, on initial load (hard navigation) and client-side navigation (soft navigation). Encode the goal as a failing @next/playwright instant() e2e and work it to green, one verified route at a time; the shipped test then…

vercel/next.js · 170 tokens