Esborrany editorial publicat per a consulta. La revisió factual i lingüística està pendent. Els exemples són il·lustratius.
Decisió i abast
La documentació ha de permetre implementar i operar sense coneixement oral ocult. Inclou objectes, camps, autenticació, permisos, exemples, errors i límits, amb propietari, versió i procés per avisar els equips consumidors abans d'un canvi incompatible.
Exemple il·lustratiu
Exemple il·lustratiu: un equip envia peticions amb referència única. La guia mostra un cas vàlid, un rebuig i un enviament repetit. Distingeix rebut d'aplicat.
Criteri d’acceptació
Demana a algú extern a la implementació provar l'exemple en un entorn separat. Corregeix passos implícits. Accepta la guia quan el receptor prova èxit, error i recuperació amb la informació escrita.
Punts clau
- Accepta la guia quan el receptor prova èxit, error i recuperació amb la informació escrita.