spec-doc SKILL.md skillA

spec-doc from ymd38/dev-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add ymd38/dev-skills/spec-doc@git:20260919.20d77cb

Pins git:20260919.20d77cb in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
ymd38/dev-skills
Path
skills/spec-doc/SKILL.md
Versions recorded
2
Latest version
git:20260919.20d77cb, committed Sep 19, 2026
First version recorded
Feb 19, 2026
Size
9,258 bytes
Repository stars
7
License
MIT

Generate or sync a "Living Specification" (docs/spec.md) from source code to eliminate doc-code drift. Use when creating, updating, or reviewing architecture documentation for a directory or module. Triggers on requests like "generate spec", "create spec.md", "sync documentation", "update architecture docs", "/maruda:spec-doc", or when asked to document a codebase directory.

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

# Role: Principal Engineer & Technical Writer (Living Spec Expert)

You are a principal-level engineer who writes documentation that functions as an executable blueprint for AI coding agents. Your specs eliminate ambiguity, prevent hallucinations, and let other agents make correct decisions without reading source code. Every word you write either adds precision or gets cut.

---

## Phase 1: Reconnaissance

Before writing a single line of the spec, build a complete mental model of the codebase.

### 1.1 Scope Assessment

Determine the target scope from the user's request:

| Signal | Scope | Output file |
|--------|-------|-------------|
| "document this directory" / path given | Single module | `docs/spec.<module>.md` |
| "document the whole project" / root path | Full codebase | `docs/spec.md` |
| "update the spec" / existing spec found | Sync mode | overwrite existing file |

### 1.2 Code Scan Strategy

Execute scans in this order to build understanding bottom-up:

1. **Entry points** — `main.*`, `index.*`, `app.*`, `server.*`, CLI entrypoints
2. **Data models** — types, schemas, DB models, proto definitions
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add ymd38/dev-skills/spec-doc@sha256:86f7391c8363a46f

The line at the top of this page pins the label git:20260919.20d77cb, 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_tyy3s4o2obz4wah7.svg)](https://markdownregistry.com/a/art_tyy3s4o2obz4wah7)

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

Versions

The registry has recorded 2 versions of this file, between Feb 19, 2026 and Sep 19, 2026, about one every 212 days.

versioncommittedcommitsizeaudit
git:20260919.20d77cb latest2026-09-19 20d77cb 9,258 BA view · diff
git:20260219.cf73b312026-02-19 cf73b31 9,244 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 (9258 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

ymd38/dev-skills · 7 stars · license MIT · pushed 2026-11-05 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_tyy3s4o2obz4wah7
GET https://markdownregistry.com/api/v1/resolve?ref=ymd38/dev-skills/spec-doc
GET https://markdownregistry.com/api/v1/blob/86f7391c8363a46f216a1c7bfd299ec6f2968f2e74370d5c439e4e554a715a6d

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 ymd38/dev-skills

data-validation SKILL.md skill
ymd38/dev-skills · skills/data-validation/SKILL.md · Inspect a project's data for correctness and produce a read-only validation report — record counts, NULL rates, value…
git:20260919.20d77cb · audit A · 7 stars
gh-batch-runner SKILL.md skill
ymd38/dev-skills · skills/gh-batch-runner/SKILL.md · Run several planned GitHub Issues as one unit: collect them under an Epic Issue with sub-issues, implement each on a…
git:20261007.6126503 · audit A · 7 stars
gh-issue-drafter SKILL.md skill
ymd38/dev-skills · skills/gh-issue-drafter/SKILL.md · Turn a rough, hand-written intent into a well-scoped GitHub Issue before planning starts. Takes a loose 'what I want'…
git:20261007.c71d404 · audit A · 7 stars
gh-issue-planner SKILL.md skill
ymd38/dev-skills · skills/gh-issue-planner/SKILL.md · Fetch a GitHub Issue by ID using the gh CLI, investigate related code, propose a structured response plan (policy…
git:20261007.a584088 · audit A · 7 stars
gh-issue-resolver SKILL.md skill
ymd38/dev-skills · skills/gh-issue-resolver/SKILL.md · Implement and verify a fix for a GitHub Issue whose response plan has already been posted as a comment by…
git:20261007.6126503 · audit A · 7 stars
progress-dashboard SKILL.md skill
ymd38/dev-skills · skills/progress-dashboard/SKILL.md · Generate an interactive HTML dashboard that visualizes improvement progress from software-evaluation and…
git:20260919.20d77cb · audit A · 7 stars
report-to-issues SKILL.md skill
ymd38/dev-skills · skills/report-to-issues/SKILL.md · Parses reports generated by the software-evaluation, vulnerability-scan or sakuda-triage skills and interactively…
git:20261022.b7d9ef6 · audit A · 7 stars
rule-proposer SKILL.md skill
ymd38/dev-skills · skills/rule-proposer/SKILL.md · Turn security findings into Semgrep rules. Reads vulnerability-scan reports, confirmed sakuda findings (via its MCP…
git:20261022.fe6cd68 · audit A · 7 stars
sakuda-triage SKILL.md skill
ymd38/dev-skills · skills/sakuda-triage/SKILL.md · Triage sakuda (DAST) findings against the source code. Pulls a scan's findings through the sakuda MCP, finds the route…
git:20261022.b7d9ef6 · audit B · 7 stars
setup SKILL.md skill
ymd38/dev-skills · skills/setup/SKILL.md · Install the full maruda harness into the current project through a short interview: CLAUDE.md, hooks…
git:20260919.a2588a5 · audit A · 7 stars
software-evaluation SKILL.md skill
ymd38/dev-skills · skills/software-evaluation/SKILL.md · Evaluate code quality across five pillars (Architecture, Reliability, Observability, Security, DX) and produce a 1-10…
git:20260919.20d77cb · audit A · 7 stars
vulnerability-scan SKILL.md skill
ymd38/dev-skills · skills/vulnerability-scan/SKILL.md · Run an offensive security audit (OWASP-based) using Semgrep and produce a read-only vulnerability report. Use before…
git:20261029.8abbb70 · audit A · 7 stars

Every file in ymd38/dev-skills

Other files named spec-doc

spec-doc SKILL.md skill
northraystudio/maruda · skills/spec-doc/SKILL.md · Generate or sync a "Living Specification" (docs/spec.md) from source code to eliminate doc-code drift. Use when…
git:20260919.20d77cb · audit A · 7 stars

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