Lightlines
By riekelt

documenting-contracts

riekelt11.4k installs

API docs that tell callers what each field means.

What it does

Guides the creation of exhaustive machine-interface documentation that explains wire formats and behavior to callers.

When to use it

Use when documenting interfaces machines call or parse, including endpoints, messages, webhooks, commands, and file formats; exclude internal code interfaces and configuration references.

How to use it

It changes how the agent writes machine-interface reference documentation in the project, documenting existing contracts rather than judging their design.

What you provide

  • An existing project

Latest review

What you need · 1

Requires the technical-writing skill as background for its hard rules, truth rules, and style.


Access · 0

No additional actions listed.