ドキュメント計画
ドキュメントの計画は柔軟なアウトラインとして機能する。執筆するコンテンツを通じたユーザージャーニーの緻密な計画を容易にする。
計画を作るときは次の質問が役に立つ。
対象の読み手は誰か?(すでにユーザーペルソナがあるかも)
プロダクトのローンチから、ユーザーにいちばん学んでもらいたいことは何か?
重要度順で考えると、どの機能からリリースされていくか?
ユーザーはローンチに何を期待しているか?
ユーザーがプロダクトや機能を使い始める前に必要な事前知識はあるか?
何のユースケースをサポートしているか?
ユーザーがつまづきそうな既知の課題や、フリクションはあるか?
table:コンテンツアウトライン
タイトル コンテンツのタイプ 簡単な説明
Corg.lyスタートガイド スタートガイド Corg.lyを使うための非常に簡単なデモと他のドキュメントへのリンク
Corg.ly: 鳴き声翻訳の解説 コンセプト Corg.lyの仕組みと技術説明
Corg.ly APIを使うための認証方法 ハウツーガイド Corg.lyのAPIを認証するためのステップバイステップの手順
鳴き声から英語への変換方法 ハウツーガイド 犬の鳴き声から英語へ翻訳するためのステップバイステップの手順
英語から鳴き声への変換方法 ハウツーガイド 英語から犬の鳴き声へ翻訳するためのステップバイステップの手順
Corg.ly APIリファレンス APIリファレンス APIの呼び出し方法と構文の一覧
音声のトラブルシューティング トラブルシューティング 音声翻訳と音声ファイルの管理でよくある問題のトラブルシュート方法
リリースノート 変更履歴 Corg.lyのリリースノート