これらのルールは、ガイドのすべてのセクションに適用されます。
- 文体 : 親切で、わかりやすく、率直な文体で記述してください。読者は、ある程度の技術知識はあってもエンジニアではない、マーケターやプロダクトマネージャーであると想定してください。
- UI 要素 : ボタン名、メニュー項目、フィールドラベルなどのユーザーインターフェース要素は太字にしてください。
例 : 「Settings > Connectors に移動し、+ Add Connector をクリックします。」 - プレースホルダー : ユーザー自身が入力する必要がある値には
<placeholder_text>を使用してください。
例 : 「Authorization フィールドに<YOUR_API_KEY>を入力します。」 - コードとペイロード : API ペイロード、URL、コードスニペットにはコードブロックを使用してください。
例 : - スクリーンショット : 主要な各ステップについて、明確で最新の高解像度のスクリーンショットを提供してください。重要な箇所を強調するために注釈を付けてください。
例:- 高品質 : すべてのスクリーンショットは、高解像度かつ最新で、はっきりと判読できるものである必要があります。
- 焦点を絞る : スクリーンショットをトリミングして、インターフェースの関連部分のみを表示してください。
- 注釈の色 : すべての注釈 (ボックス、矢印、円、ハイライト) は赤色にする必要があります。これにより、ユーザーにとって一貫した視覚表現になります。
- より大きなセクションや領域を強調するには、赤いボックスを使用してください。
- ユーザーが操作する必要がある特定のボタン、リンク、またはフィールドを指し示すには、赤い矢印を使用してください。