Dispatch
Résumé du design
Dispatch est un site de documentation en anglais pour une API d'e-mails transactionnels, répartissant navigation, articles et exemples cURL, Node et Python sur trois colonnes. Le démarrage rapide, la référence d'endpoint, les paramètres et les erreurs suivent la section lue par le développeur.
Vérification
VérifiéLes vérifications navigateur sur bureau et mobile ont confirmé la documentation à trois colonnes, le suivi du code selon les sections préparation, envoi et réponse, la mémorisation du langage entre pages et rechargements, ainsi que la navigation dans les résultats de recherche à la souris et avec Entrée.
Limites de la vérificationAucune requête API réelle, installation de SDK, création de clé réelle ni vérification du contenu du presse-papiers n'a été effectuée ; les retouches finales apportées après la revue n'ont pas reçu de nouvelle note indépendante.
Prompt
Le site de documentation développeur d'un éditeur d'API de paiement ou de messagerie (à partir de 1440×900, responsive jusqu'à 390 de large) : navigation à gauche, article au centre et exemples de code à droite basculant entre langages (cURL, Node, Python). Il comprend un démarrage rapide, la référence complète d'un point d'accès (tableau des paramètres, exemples de requête et réponse, codes d'erreur) et une recherche.
Pendant la lecture, les exemples de code suivent la section en cours et le langage choisi est mémorisé sur tout le site. Concevoir la page de démarrage rapide, une page de référence d'endpoint et la recherche ouverte.
Voir l’original en chinois
一家支付或消息类 API 公司的开发者文档站(1440×900 起,响应式到 390 宽):左侧导航、中间正文、右侧可切换语言(cURL、Node、Python)的代码示例;有快速开始、某个接口的完整参考(参数表、请求与响应示例、错误码)、搜索。
读文档时代码示例跟着当前段落走,切换语言后全站记住。设计快速开始页、接口参考页、搜索打开三个状态。
Ouvrir l'exemple interactif