laravel5.5でヘルプページを作る

laravel5.5でヘルプページを作る

今どきのWebサービスって、そもそもヘルプページが無いけど、欲しいという要望があるので作らねばならない…。

要望その1、ページ毎に画面の説明ページ(ヘルプ・ガイド)へのリンクが欲しい
要望その2、シンプルなテキストだけで良い(readme.txtみたいな感じ)
要望その3、基本的に修正しない(誤字脱字や機能追加などがあれば別)
要望その4、5~6ページ程度

1, 説明文の記述
う~ん、最初はTinyMCEで編集とか必要かな?と思ったけど、この程度ならテーブルも不要だな。
説明文をソース直書きでもいいけど、せめてconfigファイルくらいには外出にしよう。phpstormなどIDEを使っていれば、説明文の中にシングルクォーテーションも円マークでエスケープされる。
config/help.php

2, 表示画面テンプレートも作る
resources/views/auth/help.blade.php

3, HelpController.phpを生成して、制御処理を記述
php artisan make:controller HelpController

4, web.phpにルーティングを記述

リンク元が認証ありなしが混在しているので、URLさえ知っていれば見れるように認証はかけない!
ヘルプ画面別に認証をかけるなら、HelpControllerに記述する。

5, ヘルプページへのリンクボタンは、ナビバーに配置。画面別にリンク先を変更するのでURLを元に変える。
各ページの操作説明なら、ナビバーじゃなくてページ毎にリンクボタンを置いた方が良いと思う(認証のページとかあると特にそう思う)
デザイン的な問題もあるから判断が難しい。

コメントを残す

メールアドレスが公開されることはありません。