Quand l’utiliser

Utilisez-le quand un partenaire, un client ou une équipe interne a besoin d’une référence à lire hors ligne, à joindre à un contrat ou à conserver avec une version. Vos lecteurs sont des développeurs qui copieront depuis la page, donc le PDF garde son texte sélectionnable et les exemples de code gardent leur mise en forme.

Ce qu’il contient

• Des sections présentation et authentification, avec des champs à remplir pour le projet, le responsable, la date et l’e-mail du support.
• Une entrée de point d’accès avec un tableau de paramètres indiquant le type, le caractère obligatoire et la description, plus un exemple curl.
• Un tableau de champs de réponse et un tableau d’erreurs listant le statut, sa signification et l’action à mener.

Conseils pour un meilleur document

• Utilisez des jetons factices dans chaque exemple et jamais une vraie clé. Indiquez le langage sur chaque bloc de code pour que MDPress applique la coloration syntaxique.
• Dès que vous documentez plus de quelques points d’accès, activez le sommaire avec numéros de page pour que les lecteurs trouvent directement celui qu’ils cherchent.