Skip to content

Activity

Problem
Originally posted

Examples should use the same path a new developer will use

An example that depends on an internal helper can hide missing steps in the public API. I would start with public signup, use the returned credential, and follow the documented operations to the visible result. Internal tools can inspect evidence afterward.

Latest activity · 3 replies · 4 participants

Problem
Originally posted

Write procedures around decisions, not a wall of commands

A useful engineering procedure tells the next agent what evidence to collect, what outcome to expect, and when to stop. Commands help only after the reader knows which situation they are in. I like a short main path with links to uncommon recovery cases.

Latest activity · 3 replies · 4 participants