Oppdateringer
Utleggsappen utvikles kontinuerlig. Nye funksjoner lander ofte først som endringer i API, klientflyt eller integrasjoner før hele dokumentasjonsbildet er oppdatert.
Hva denne delen bør brukes til
- forklare større funksjonelle endringer
- samle migreringsnotater eller viktige endringer i arbeidsflyt
- peke videre til mer detaljerte emnesider når en funksjon er moden
Dokumentasjonsprinsipp
Når en funksjon endres, bør dokumentasjonen oppdateres på emnesiden der brukeren forventer å finne svaret, ikke bare i en generell endringslogg.
Nerdehjørnet
Bruk denne delen sparsomt. Varig atferd bør dokumenteres på riktig emneside, mens denne delen først og fremst bør oppsummere større endringer, deprecations og migreringsvinduer for eksterne brukere av produktet eller API-et.