New Cohort Starts:

Donate
← Back to the skill map
Engineering Practice/Systems & practice

Documentation

3 micro-topics in Engineering Practice, each with the evidence that proves you have it and the written reason behind every link. Before you start, it rests on 1 other domain. Downstream, it holds up 1 domain.

3 topics  ·  depth 0–4 of 16  ·  2 internal links  ·  1 in  ·  1 out

Before you start

Load-bearing links first. Each one says what in this domain rests on what outside it, and why.

API Contracts

1 link

load-bearing

Document an API rests on Design an API contract

You document a contract you have designed.

What you will be able to do

In prerequisite order. Each idea names the artifact that closes it, the market demand that put it on the map, and what it stands on.

Depth 0  ·  representational  ·  unassisted  ·  M07 §7.4

Write a README people can act on

Covers what it is, how to run it, how to contribute

Evidence
A stranger runs the project from the README alone
Market anchor
Technical writing
Rests on
Nothing sits under this one — it is an entry point.

Depth 0  ·  representational  ·  scaffolded  ·  M07 §7.4

Write a runbook

Turns an operational procedure into steps under pressure

Evidence
Someone else executes the procedure at 3am
Market anchor
Operations · technical writing
Rests on
supporting

Write a README people can act on

A runbook is a README for an operation.

Depth 4  ·  representational  ·  unassisted  ·  M07 §7.4

Document an API

Describes endpoints, shapes and errors

Evidence
Publishes docs a client developer builds against
Market anchor
Technical writing · API design
Rests on
load-bearing

Design an API contract · API Contracts

You document a contract you have designed.

supporting

Write a README people can act on

API docs are a specialized README skill.

What rests on this domain

Everything downstream that names an idea here as a prerequisite, grouped by where it lives.

AI Safety & Governance

1 link

load-bearing

Run an AI incident response rests on Write a runbook

Incident response runs from a runbook.

Retool. Retrain. Relaunch.

375 ideas. 17 weeks. No tuition, ever.

Vets Who Code is a veteran-run 501(c)(3). The accelerator is free, remote, and we don’t take a share of your first paycheck.

Free · Remote · 17 weeks · EIN 86-2122804