【サンプル】概要ページテンプレート

メニューを利用する上で前提として必要な準備 (利用環境など) や

知っておくべき基本概念 (管理手段や画面、リソースの名称と種類など)、

利用開始するまでに踏むべき手続き (ユーザ設定や権限設定など) について記載します。

概念の説明については「〇〇について」ではなく、「〇〇とは」という記載とすることで、

概念の説明であることが分かるようにしてください。

メニューを利用する上でユーザが利用する機能について、

機能とその利用シーン別に章を分けてチュートリアルを執筆します。

各章、小項目のタイトルは「〇〇機能について」ではなく、必ず「△△を××する」という動詞形で記述するようにしてください。

補足情報や注意が必要な情報について述べる場合はその限りではありませんが、その場合も

「××するために必要な〇〇について」や「△△する場合の〇〇について」という形で、

必ず情報が必要となるタイミングを明確化するようにしてください。

ユーザーからの問い合わせが頻発するようなケース、トラブルが発生しやすいことが事前に分かっているケースについて、

対処方法を示すことでユーザーの自己解決を支援します。

章のタイトルには必ずその事象が発生するタイミングや条件を明記してください。

「〇〇をしたいけど△△できない」、「××という状況で〇〇が発生してしまう」、など

ユーザーが問い合わせを行う際のチケット起票や確認の手順を記載します。

チケットを起票する際に運用保守担当が切り分けを行うために記載して欲しい情報、

チケットの起票フォーマットの説明など、メニュー特有の情報を必ず記載するようにしてください。