make-a-project-overview SKILL.md skillA

make-a-project-overview from jessitron/iterate-on-docs is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add jessitron/iterate-on-docs/make-a-project-overview@git:20261014.ddff87c

Pins git:20261014.ddff87c in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
jessitron/iterate-on-docs
Path
skills/make-a-project-overview/SKILL.md
Versions recorded
5
Latest version
git:20261014.ddff87c, committed Oct 14, 2026
First version recorded
Oct 12, 2026
Size
5,560 bytes
Repository stars
16
License
CC0-1.0

Draw a visual overview of a whole project: one self-contained HTML page, `OVERVIEW.html` at the repo root, with diagrams of where the project is headed, its architecture, and the current work. Stingy with words, made for a human to take in fast. Then refine it with the user. Use when the user says "make a project overview", "draw me a picture of this project", "give me an overview page", or "update the overview".

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# Make a project overview

Goal: give a human a fast picture of a whole project in one HTML page, then refine it with them
until they say it is good enough.

Quest: make this project live in the human's head, and in the agent's understanding, consistent with each other and with the code.

## What the overview is

A single HTML page, `OVERVIEW.html` at the repo root. It conveys information with pictures and
diagrams, and it is stingy with words. It is HTML with diagrams, not markdown, because it
optimizes for rapid human comprehension.

**Audience.** People who come to the project: its author coming back after time away and wanting
their bearings, teammates, newcomers. Its author also reads it over time, to see how the
architecture changes. Agents can read it, but it is not written for them; agent-facing notes stay
in markdown.

**Usual material, not a template.** Choose what helps this reader, on this project, now. One
project needs no context map; another needs a picture nobody else would draw.

- **Purpose:** the problem this project solves
- **Direction:** where it is headed: its goals, and what
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add jessitron/iterate-on-docs/make-a-project-overview@sha256:24d8f0274f813d05

The line at the top of this page pins the label git:20261014.ddff87c, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_lzhjyneopqth3xkz.svg)](https://markdownregistry.com/a/art_lzhjyneopqth3xkz)

1 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 5 versions of this file, between Oct 12, 2026 and Oct 14, 2026, more than one a day.

versioncommittedcommitsizeaudit
git:20261014.ddff87c latest2026-10-14 ddff87c 5,560 BA view · diff
git:20261014.d184a202026-10-14 d184a20 5,560 BA view · diff
git:20261012.43c47ea2026-10-12 43c47ea 5,410 BA view · diff
git:20261012.8bdffb62026-10-12 8bdffb6 5,294 BA view · diff
git:20261012.c3b3d212026-10-12 c3b3d21 5,686 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (5560 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

jessitron/iterate-on-docs · 16 stars · license CC0-1.0 · pushed 2026-11-01 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_lzhjyneopqth3xkz
GET https://markdownregistry.com/api/v1/resolve?ref=jessitron/iterate-on-docs/make-a-project-overview
GET https://markdownregistry.com/api/v1/blob/24d8f0274f813d0529473e067da9b1400e1a9a3e2340bef322d2d5e913c7a907

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from jessitron/iterate-on-docs

CLAUDE.md CLAUDE.md file
jessitron/iterate-on-docs · CLAUDE.md
git:20261012.9303082 · audit A · 16 stars
iterate-on-a-document SKILL.md skill
jessitron/iterate-on-docs · skills/iterate-on-a-document/SKILL.md · Refine a markdown or HTML document with the user by trading turns until they say it is good enough. The user edits the…
git:20261027.5c47e3b · audit A · 16 stars

Every file in jessitron/iterate-on-docs

Browse by kind, by grade A, or by owner.