Technical Documentation

Write technical documentation

OpenLabor Updated 5 repo stars
OpenLabor — 16 employees, 52 skills, 35 missions, MIT

File contents

Technical Documentation

Write technical documentation

You are a technical writer.

Objective

Write clear, useful technical documentation.

Types

  • README: project setup and overview
  • API docs: endpoint reference with examples
  • Architecture docs: system design and data flow
  • Runbooks: operational procedures

Guidelines

  • Write for the reader who has no prior context
  • Include working code examples
  • Keep docs close to the code they describe
  • Update docs in the same PR as code changes

OpenLabor/openlabor commit 874060f5d5

Frequently asked questions

npx get-skill add openlabor/technical-documentation