思うこと私は現在ホームページの作成などをしています。(html、css、javascript、phpなど)と勉強を始めて10年程経ちました。最初のころは・・・・・、前置きが長くなるところでした(笑)。気を取り直して本題です。ホームページ制作を長年してきた中で「静的ページ」から「WordpressなどのCMS」へと構築の方法が変わってきました。「WordpressなどのCMS」では、「お知らせ」や「ブログ記事」の追加や更新、サイトに掲載されている情報の更新など、サイトを育てることができます。追加や更新などの作業は慣れていない人にとって思いのほか敷居が高く、マニュアルが必要となります。実際にいろいろな形のマニュアルを作成してきました。その中で、ずっと考えていたことがあります。どのような形のマニュアルがクライアントにとって良いマニュアルなのか?それについて今の段階での考えをまとめておきます。マニュアルは案外見ない?ガラケーやスマートフォン、その他家電など、様々なものにマニュアルがあります。性格にも依りますが、「マニュアルは基本的には見ない」、「必要になった際に見る程度」といった人が多いのではないでしょうか。実際に私はそうですし、周りにも多いです。見ない理由は、ガラケーやスマートフォンの基本的な使い方がどれも大体同じであったり、ボタンを見るだけで何ができるかすぐ分かるなどだと思います。下記のような3つが考えられます。機能が限定されている例えば炊飯器であれば、「ご飯を炊く」、テレビであれば、「番組を映す」など。現在は色々と機能が搭載されていますが、基本的にできることは限定的です。制限されることでシンプルになります。シンプルなほどマニュアルがなくても操作しやすくなります。わかりやすくデザインされている利用者の操作は「開始する(点ける)」・「止める」・「予約する」あたりが多いかと思います。「開始する」、「止める」に関しては、ボタン1つで事足ります。そのボタンが分かりやすければ、マニュアルは必要ありません。「予約する」も予約ボタンと時間を設定するボタンさえあれば操作可能で、同じく分かりやすいデザインであればマニュアルは不要です。製品が普及している普及している製品の場合、デザインが似ていたり、大体でわかる部分が多くなります。利用経験者が多く、マニュアルを見なくても平気な人が多くなります。見るときはいつ?基本的には見ない私ですが、見る時もあります。必要最低限の使い方に慣れてきたときに、下のような欲がでてきます。「これができると便利なのに」(先に考える方も多いと思いますが・・・)そういった時にマニュアルを見ることがあります。マニュアルを見ないにしても、ネットで調べたりして、より良い使い方を探します。この場合、目的があるため、マニュアルの中の必要箇所だけ見ればよかったり、既に製品を利用している分、マニュアルも見やすく感じます。知りたいという欲求があることで記憶にも定着しやすいです。必要なときに見るのが一番効率的に感じますし、その際にはマニュアルは大きな手助けをしてくれます。行ったり来たりは大変?マニュアルを見ながら製品を触ることができます。それでは、サイトの更新などの場合はどうでしょうか。パソコン上でマニュアルと管理ページを行き来しながら、確認・対応を行います。操作が慣れないという方は印刷して使用することもできます。自分の経験や、想像をしてみても、思いのほか大変ではないように思います。まとめ主観と自分の周りまでの狭い話にはなりますが、「必要に応じて見る」といった感じかと思います。何か困ったときにマニュアルを見るというのが一番近いように思います。それが最初の段階の人もいれば、使ってみてしばらくしての人もいるかと思います。昨今ですと、マニュアル以外にも大体のものはネットで調べれば解決したりします。マニュアルよりそちらで調べる人の方が多いかもしれません。サイト更新のマニュアルについて考えるサイトを更新する際、入力するページ(入力画面)とマニュアルの行き来は無しで、「入力画面だけで完結するのが良い」と考えていました。色々な観点で考えてみると、そうではないと思う部分もあります。入力画面だけで完結すると、余計複雑になる?入力画面だけで、完結しようとすると、説明文が多くなり、見にくく、分かりにくいものになってしまいます。使い方を覚えてくると、説明文は「余計な情報」となり、邪魔なだけになります。忘れたときなどには便利ですが、日々更新するのであれば、説明文がない方がスムーズに更新できるという可能性もあります。まとめると、操作を覚えるまでは良い点もあるが、それ以降は不便になる可能性が高い。更新者が早々に入れ替わることは無いと考えると、「操作を覚えるまでの期間」と「それ以降の期間」であれば、明らかに「操作を覚えるまでの期間」の方が短いと思います。よって、すべての説明文を入力画面に入れることは望ましくないと思われます。※説明文の「表示/非表示」を切り替えられるのであれば、入力画面で完結するのも「有り」かもしれません更新者が知りたいことは何?実際に更新する方が知りたいことは何でしょう?私がマニュアルを作成する場合、掲載する内容は、下記3点がメインとなります。よって反映される箇所それに加えて注意点等を要所に入れる形です。実際に私が見てきたマニュアルもこの形が多かったように思います。私が見てきたマニュアルは、ECサービス関連のマニュアルが多いです。ECサイトにデザイン反映をしたり、各種設定の補助等も行ったりするためです。※私用ではあまり見ませんが、仕事では結構見ていました(今気づきました)それでは、上記3点に関してそれぞれ見ていきます。基本的な操作とは、記事の追加や編集の一連の流れに必要な操作です。下記のような感じです。※実際は画像を載せたり、注釈が入ったりします。(例)新規作成1「新規作成」をクリック2「タイトル」・「本文」を入力3「公開」をクリックこの説明ですが、Wordpressなど該当のCMS自体を触ったことがあるという人には不要です。CMS自体初めてという方には必要な説明です。入りたての新人さんでCMSも知りませんという方が更新者になる可能性もありますので、必要なマニュアルにはなります。クライアントごとに分ける必要はなく、共通のマニュアルとして一つ作成すれば良い内容だと考えています。よって、入力画面には説明ではなく、マニュアルページへのリンクを貼るだけでOKな説明項目だと思います。Fieldsの繰り返しフィールドの追加・削除方法などです。説明が無いと分かりにくい部分です。こちらも「基本的な操作」と同じく、経験者には不要、未経験者には必要な説明です。マニュアルの形としても同様で、クライアントごとに分ける必要はなく、共通のマニュアルとして一つ作成すれば良い内容だと考えています。よって、マニュアルページへのリンクを貼るだけでOKな説明項目だと思います。変更・入力によって反映される箇所とは、変更・入力によってサイト上のどの部分に反映されるかの説明になります。基本的にはサイトの該当箇所の画像(赤枠などでどの部分か分かりやすくします)を貼り、説明します。この部分は、サイトごとに異なるため、Wordpressなどの経験者にも必要なマニュアルになります。※経験者であれば、どこに反映されるか分かる可能性は高いですが、マニュアルがあった方が手間は減りますですが、入力画面に画像があるとかさばります。「入力画面だけで完結すると、余計複雑になる?」で書いた理由と同じく『反映箇所を覚えるまでは良い点もあるが、それ以降は不便になる可能性が高い。よって、こちらも別ページにある方がより良いです。サイトはそれぞれ異なるデザインのため、共通のマニュアルとはいきません。サイトに直接マーキングするサイトごとにマニュアルを作成するのはたいへん手間になります。サイトのデザイン変更などの改修があった場合も、マニュアルの方も画像の差し替えなどが発生します。そこで、サイト自体にマーキングするという方法を考えました。詳しくは下記ページをご覧ください。【実用中】サイトの更新方法などのマニュアル作成時に役立つ機能をjQuery(avascript)で作成https://lucklog.info/func-wordpress-for-explain/ここ数年、ホームページ構築はWPなどのCMSを用いることが多くなりました。サイトの記事を増やしていくことは、SEOにも効果があるので、当然の流れだと思います。...↑こちらを利用することで、「基本的な操作」「細かい操作」と同様に入力画面には「反映箇所はこちら」といったリンクを貼るだけで良くなります。すれば、かさばらない、かつサイトごとに作成する必要もありません。サイトのデザイン変更があった場合でも「class名」をキーにマーキングするため、影響を受けません。実際のサイト上にマークされるので、反映箇所がとても分かりやすいかと思います。マニュアル作成側だけではなく、クライアントにも分かりやすい機能だと思っています。現時点でのまとめマニュアルの作成は必要です。基本的には共通のマニュアルの作成のみとします。各クライアントの入力画面に共通マニュアルへのリンクを貼ります。することで共通マニュアルを良くしていくだけで、全クライアントに更に質の良いマニュアルを提供し続けることができます。次に、「反映箇所」というサイトごとに必要な説明項目に関しては、独自に作成したマーキングツールを利用し、反映箇所を伝えます。各自のサイト上にマーキングされるため、分かりやすく、デザイン変更等にも影響を受けません。新しい更新者への引き継ぎ時も説明しやすいかと思います。現時点でのマニュアルの在り方について作成するマニュアルは共通のものだけ共通マニュアルの質を高めていく反映箇所はわかりやすくマーキングツールを使うマーキングツールの質を高めていく今後もより良いマニュアルの在り方については考え続けていきます。思ったこと【読書】読んでいる途中ですぐ読み直す。『Atom』で一括検索(プロジェクト内検索)ができない。勘違いした原因は?【Wordpress】SSL対応を行った後、管理画面で「このページにアクセスする権限がありません。【Python】Anacondaをインストール。【WP】解除したい!『現在メンテナンス中のため、しばらくの間ご利用いただけません。【Python】2.画像からHTMLを自動生成する仕組み※深層学習ではありません~for文減少への追求~【Python】1.はじめに~for文減少への追求~【読書】読んでいる途中ですぐ読み直す。