technical-writing SKILL.md skillC

technical-writing from atnexuslab/tightship is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add atnexuslab/tightship/technical-writing@git:20261015.8e86e2c

Pins git:20261015.8e86e2c in mdr.lock. Pin the fingerprint instead.

Audit grade
C, 14 of 17 checks passed
Kind
SKILL.md skill
Repository
atnexuslab/tightship
Path
content/skills/technical-writing/SKILL.md
Versions recorded
1
Latest version
git:20261015.8e86e2c, committed Oct 15, 2026
Size
4,966 bytes
Repository stars
4
License
MIT

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

+++
name = "technical-writing"
description = "Use when writing or updating a README, a page under docs/, or a runbook — whether the doc should exist, where each fact belongs, and how it stays true as the code moves."
+++

# Technical Writing

A doc is a claim about the code, and it decays the moment the code moves. Write the fewest docs that
answer real questions, put each fact in exactly one place, and prefer the form that cannot go stale.

**Scope.** This skill names criteria, never tools. A repo on this workflow takes its docs structure,
diagrams, and site from `{{skill:project-docs}}`; any other repo takes them from its own `AGENTS.md`.
Project docs live in the **repo** — never only in memory.

## Before writing: should this doc exist?

Every doc is another surface that drifts. It earns its place only when it answers a question that
**nothing else already answers** and someone will actually ask.

Already answered — do not write it down:

- What the code says. A reader who needs the exact behavior reads the code, and prose about it will
  disagree with it eventually.
- What a tool prints. Command-line help, a generated schema, a type definition, a config template.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add atnexuslab/tightship/technical-writing@sha256:ed73b1e35161cf36

The line at the top of this page pins the label git:20261015.8e86e2c, 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_jqvfhneo55lllxtp.svg)](https://markdownregistry.com/a/art_jqvfhneo55lllxtp)

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

Versions

The registry has recorded 1 version of this file, committed on Oct 15, 2026.

versioncommittedcommitsizeaudit
git:20261015.8e86e2c latest2026-10-15 8e86e2c 4,966 BC view

Audit of the latest version

C  14 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • fail: Frontmatter block present
  • fail: Frontmatter declares a name
  • fail: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (4966 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

Starting a new one? Use a template for SKILL.md on mdpantry, which passes every one of these checks and says what to change in it.

Source

GitHub

atnexuslab/tightship · 4 stars · license MIT · pushed 2026-10-22 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_jqvfhneo55lllxtp
GET https://markdownregistry.com/api/v1/resolve?ref=atnexuslab/tightship/technical-writing
GET https://markdownregistry.com/api/v1/blob/ed73b1e35161cf36e840bd48b635758b1ae6bc8da6fefeefa5ab74b6d65aabe3

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 atnexuslab/tightship

cursor-plugin SKILL.md skill
atnexuslab/tightship · .claude/skills/cursor-plugin/SKILL.md · Use when building, rendering, or debugging the Cursor plugin of this repository — Cursor's plugin layout, what each…
git:20261017.0afecbf · audit A · 4 stars
AGENTS.md AGENTS.md file
atnexuslab/tightship · AGENTS.md
git:20261017.af09dc7 · audit A · 4 stars
api-design SKILL.md skill
atnexuslab/tightship · content/skills/api-design/SKILL.md
git:20261015.8e86e2c · audit C · 4 stars
architecture-reading SKILL.md skill
atnexuslab/tightship · content/skills/architecture-reading/SKILL.md
git:20261015.8e86e2c · audit C · 4 stars
database-design SKILL.md skill
atnexuslab/tightship · content/skills/database-design/SKILL.md
git:20261015.8e86e2c · audit C · 4 stars
frontend-architecture SKILL.md skill
atnexuslab/tightship · content/skills/frontend-architecture/SKILL.md
git:20261015.8e86e2c · audit C · 4 stars
grilling SKILL.md skill
atnexuslab/tightship · content/skills/grilling/SKILL.md
git:20261015.bf2e316 · audit C · 4 stars
hexagonal-architecture SKILL.md skill
atnexuslab/tightship · content/skills/hexagonal-architecture/SKILL.md
git:20261015.8e86e2c · audit C · 4 stars
performance-analysis SKILL.md skill
atnexuslab/tightship · content/skills/performance-analysis/SKILL.md
git:20261015.8e86e2c · audit C · 4 stars
project-docs SKILL.md skill
atnexuslab/tightship · content/skills/project-docs/SKILL.md
git:20261015.4cfc585 · audit C · 4 stars
requirements-engineering SKILL.md skill
atnexuslab/tightship · content/skills/requirements-engineering/SKILL.md
git:20261015.8e86e2c · audit C · 4 stars
security-audit SKILL.md skill
atnexuslab/tightship · content/skills/security-audit/SKILL.md
git:20261015.8e86e2c · audit C · 4 stars

Every file in atnexuslab/tightship

Other files named technical-writing

technical-writing SKILL.md skill
cursor/plugins · harness/pstack/claude-code/skills/technical-writing/SKILL.md · Layered technical-writing standard: Diátaxis structure, Google developer style sentences, STE instruction rules, Global…
git:20261016.182f2ce · audit A · 13,494 stars
technical-writing SKILL.md skill
cursor/plugins · pstack/skills/technical-writing/SKILL.md · Layered technical-writing standard: Diátaxis structure, Google developer style sentences, STE instruction rules, Global…
git:20261010.00b14f1 · audit A · 13,494 stars
technical-writing SKILL.md skill
michael-denyer/pstack-claude · plugins/pstack/skills/technical-writing/SKILL.md · Layered technical-writing standard: Diátaxis structure, Google developer style sentences, STE instruction rules, Global…
git:20261013.058a348 · audit A · 3,263 stars
technical-writing SKILL.md skill
backnotprop/pstack · skills/technical-writing/SKILL.md · Layered technical-writing standard: Diátaxis structure, Google developer style sentences, STE instruction rules, Global…
git:20261012.f3afb70 · audit A · 2,481 stars
technical-writing SKILL.md skill
openhands/extensions · skills/technical-writing/SKILL.md · Guides technical explanations toward flowing, direct, conversational prose. This skill should be used for engineering…
git:20260713.fc09aef · audit A · 171 stars
technical-writing SKILL.md skill
nahid-sparktales/agent-dispatcher · skills/knowledge/technical-writing/SKILL.md · Write or repair documentation that stays true to the system it describes — README, setup guide, how-to, API reference…
git:20260919.a0d4f55 · audit A · 59 stars
technical-writing SKILL.md skill
korallis/agent-stack · skills/technical-writing/SKILL.md · How to write docs, SPECs, READMEs, runbooks, PR descriptions and commit messages that a tired engineer understands on…
git:20260930.ce1c74b · audit A · 35 stars
technical-writing SKILL.md skill
toongri/oh-my-toong-playground · skills/technical-writing/SKILL.md · Use when reviewing, improving, or writing technical documentation in Korean. Triggers include "문서 리뷰", "테크니컬 라이팅", "기술…
git:20260917.d8080c9 · audit A · 25 stars

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