使う場面

取引先やクライアント、社内チームがオフラインで読める資料、契約に添付できる資料、リリースと一緒に保管できる資料を必要とするときに使います。読み手はこのページから内容をコピーする開発者なので、PDFの文字は選択可能なまま保たれ、コード例の書式も崩れません。

含まれる内容

• プロジェクト名、担当者、日付、問い合わせ先メールを入力する欄を含む、概要と認証方法の項目。
• 型、必須かどうか、説明を示すパラメータ表と、curlの例を含むエンドポイントの項目。
• レスポンス項目の表と、ステータス、意味、対応方法を示すエラー表。

より良い文書にするヒント

• すべての例でプレースホルダーの文字列を使い、実際のキーは絶対に載せないようにしましょう。各コードブロックには言語を指定すると、MDPressがシンタックスハイライトを適用します。
• エンドポイントが数個を超えたら、目次にページ番号を付けて、読み手が必要な項目にすぐ進めるようにしましょう。