マニュアルサイトを作ります。

WebClassの マニュアルサイト を作ることにしました。WebClassの中でも新機能開発が盛んな学習記録ビューアの解説を中心に、内容を充実させている真っ最中です。
作成の目的は以下のようなものです。

  • Google検索から使い方を調べられるようにしたい
  • Webの特性をフルに活かした効果的なマニュアルにしたい
  • ユーザだけでなく社内でも活用できる
  • アクセス履歴から製品の改善に役立つ情報を見つける

それぞれ説明していきます。

Google検索から使い方を調べられるようにしたい

これまでWebClassのマニュアルは主にPDFで用意し、WebClassにログインしてダウンロードしていただく形で提供してきました。現代において、アプリやサービスについて何か情報を得たい時は、とりあえずGoogle等の検索サイトで検索する事が多いのではないでしょうか。WebClassのユーザーも例外ではなかったかと思います。実際にWebClassの情報を検索すると、ヘビーユーザーのかたが使い方を分かりやくすまとめたサイトが見つかったりします(ありがとうございます!😊 )。私たちもマニュアルサイトを通して、必要な情報を必要な時に見つけることができるような状況を作ります。

Webの特性をフルに活かした効果的なマニュアルにしたい

前述したように、これまではマニュアルをPDFで配布してきました。これをWebサイト化することで、段違いの表現力を期待できます。分かりやすいように情報をページに分割したり、リンクで関連する情報を相互に結びつけることができます。動画やアニメーションGIFも強力な武器になるでしょう。

ユーザーだけでなく社内でも活用できる

社内で情報共有するための資料はありますが、マニュアルサイトのようにユーザーも含めた多数の人が参照する状況にすることで、より情報の鮮度を保つ原動力になります。ユーザがマニュアルサイトを見ることで必要な情報をが得られる状況になれば、サポートコスト低減にも繋がります。

アクセス履歴から製品の改善に役立つ情報を見つける

マニュアルサイトにアクセスしてきたユーザーは、WebClassの画面だけでは分からなかった情報を探しにやってきています。アクセスが多いページや検索ワードから、WebClsasで迷いがちなポイントを知り、WebClassの改善に繋げていきます。

今後

マニュアルサイトを構築したばかりで、目的の達成にはまだ時間がかかりそうです。徐々にではありますが、内容を充実させていき、即時性の高いサポートを目指していきます。

余談ですが、マニュアルサイトを公開したのと同じ頃、ヘルプサイトの作り方 なんて本が出版されていました!今読んでいますが、すぐに活かせそうです。

植物

こんにちは。福岡です。

開発チームの事務所では、3つの植物を育てています。1つは種類の名前がわからなくなってしまいました。

ペペロミア
種類がわからない
アイビー

ツルのアイビーが強いかと思いきや、去年にいちど枯らしてしまいました。土にカビがつく「うどんこ病」というのにかかったみたいで、水の管理が悪かったと思っています。お世話をしてくれているスタッフの希望で、再チャレンジのため鉢を買いなおしました。

緑があるのは気持ちがいいです。また、様子を見ながらお世話をして育てるのは開発やサーバの保守とある意味似ているところもあり、難しくも楽しくもあります。

WebClassログイン画面のHTTP Status

こんにちは。福岡です。

WebClassはクラウドサービスも行っています。そこで弊社でも稼働ステータスを監視しています。オンプレミスのサーバでご利用いただいている学校でも、学校でWebClassサーバの監視を何かしら行っているケースは多く、監視に関する質問を頂くこともあります。 OSのメトリクスは一般的なツールで取りやすいと思いますが、WebClass のアプリケーションに関するステータスはどう取ったらいいか、あまり情報を提供したことがなかったかもしれません。そこで、稼働状況を確認するのに使えそうな、 v11.6.0 のログイン画面の表示とHTTPステータスについてご案内します。

ログイン画面の表示のパターン

ここでは前提として、特にSSOの設定がないケースを想定しています。何かしらのSSOを設定していて、未認証の状態でログイン画面を開くと別のページに転送される環境は当てはまりません。

ログイン画面は以下の2つのパラメータで4つの表示のパターンを持っています。

  • システムオプションのMAINTENANCE_MODE ON/OFF
  • DB への正常な接続 Yes/No

正常時

通常は、次のようなログイン画面が表示されます。HTTP Status は200です。

メンテナンス中

メンテナンスモードに切り替えている間は、下図のようにメンテナンスモードのメッセージが表示されます。HTTP Status は 200 です。通常のユーザはログインできませんが、すでにログインしている人はまだ操作を続けることができます。

メンテナンス中でDB停止時

メンテナンスモードに切り替えていて、かつ DB に接続できない状態の場合は、表示が変わります。この状態では仮にログインしたままのユーザがいても、操作はできません。メンテナンスメッセージは1つしか設定できないのでそのまま表示されますが、ログインフォームは表示されなくなります。HTTP Statusは503 になります。

予定外のDBアクセス不可

もしメンテナンスモードでないときに DB にアクセスできないときは、以下の表示となります。HTTP Statusは500になります。

応答時間

上記はHTTPレスポンスが帰ってくるケースになりますので、Webサーバがリクエストを受け取って応答可能な状態です。

ログイン画面の応答時間で負荷状況もだいたいはわかるかもしれませんが、サービスが実質利用可能かどうかはコースの教材一覧やテストの画面の速度が問題になります。

レポート再提出期限を過ぎた後の期限変更や再提出の不具合

こんにちは。福岡です。

WebClass の少なくとも v11.0~ と v11.6.0 において、レポート提出期限に関するバグが見つかっていますので、ご案内します。

症状

「回答の見直しを許可」を有効にしたレポート課題に、学生がレポートファイルを提出します。

学生の提出に対して、先生がレポート採点画面で再提出指示をだします。このとき、提出期限を設定しておきます。

学生が再提出しないまま再提出期限を過ぎた後で、先生がレポート採点画面で再提出期限を変更して保存すると、ここで再提出指示のデータ不整合が起きてしまいます。ただし、再提出の期限は更新されます。

ここでは、学生が更新された再提出期限までにレポート提出することができます。ですが、この後で改めて再提出指示が出された場合は、もう一度再提出をしようとするとエラーになってしまい、提出ができません。

対応方法

上記の状態になってしまった学生に対して、先生がレポート採点画面で「再提出指示をキャンセルする」ボタンで一度キャンセルします。

改めて再提出指示を出すことで、学生は提出できるようになります。

プログラムの修正状況

問題を特定できましたので、修正対応中です。

ご不便をおかけしております。

リリースの案内

こんにちは。福岡です。

本日 WebClass Ver.11.6.0 のパッチをリリースいたしました。ご利用いただいている学校の管理者の方には案内のメールを差し上げていっています。

リリースの時期はこれまで3月と9月だったのですが、次の学期の開始に間に合わなかったり、管理者や先生も変更点を確認する余裕もないタイミングでした。そこで時期を少し前にずらし、1月末と7月末に変更してスケジュールしています。この年2回のリリースは定期リリースのタイミングで、その時の状況により間のタイミングで追加の案内を差し上げることもあります。

また、管理者の方もユーザとしてご利用いただく先生や学生に向けて変更等の案内できるよう、案内資料を用意いただいているケースもあるかと思います。そこで今回から、パッチの案内をしているページでリリースノートのワードファイルと、パッチに組み込まれているマニュアルのPDFファイルをダウンロードできるようにいたしました。パッチを当てなくても先にマニュアルを確認したり、リリースノートも編集してお手元でご利用いただくことができます。

まだまだ素材としては荒いところもあるかと思いますが、ご利用いただきやすいように順次整えていきたいと思います。