※このホームページは、バリアフリーを目指し、音声読み上げソフトに対応しています。

 


新・電子ノートブック Snap Note 3
  フリーソフト Snap Note 3 mini 公開!  

ソフトウェア・デザイン館 Sage Plaisir 21 へようこそ!
隔週月曜更新 : 毎週1つのニュースまたはプログラミング技術を取り上げ、解説します。

東日本大震災 まとめページ

[PR] 最強のスクリプト・ライブラリ vbslib5 が Windows 10 に対応!
[PR] シェル・スクリプトを格段に使いやすくする bashlib1 公開中


2020年より、IT ニュース&コラムは 3週に1度の配信となります。

週刊 IT プログラミング技術 2021/ 7/19

区切り記号を操作ステップに合わせて入れると探しやすい - 構造化文書 (2)


このシリーズのタイトルを手順メモから構造化文書に変更しました。
理由は対象となる文書が手順書だけに限らないことと、
目指しているところが構造化プログラミングに似ているからです。

前回、メニューやボタンなど操作対象の位置を上下左右で示すことが効果的であることを
説明しました。 今回もメニューやボタンの操作を早く間違いなく行うことに適した
文書とは何かを説明します。

手順書を見ながら操作するときに、具体的にどういう動きをしているかを分析してみましょう。

1. 手順書を見て操作対象を知る。例:「設定」メニュー項目
2. 操作対象を探す。このとき、上下左右の位置が分かれば探しやすい
3. 操作する
4. 次の操作をする(1.へ戻る)

手順書通りに操作することとは、以上のことを永遠と繰り返すことです。
それは、ある意味、退屈な作業です。
しかし、操作をすることが目的なのではなく、操作することで何かを成し遂げることが目的です。
操作することに慣れていくと、作業や仕事が進んでいく様子を意識できるようになり、
退屈ではなくなります。

もし、手順書が的確でなければ、具体的にどのように操作しなければならないかを
考えなければならないので、退屈しないでしょう。
しかし、あっという間に時間を消費してしまい、手順書通りに黙々と進めていく人よりも
結果を出すのは遅くなります。

話を戻して、手順書を見ながら操作することは、見知って、探して、操作する、の繰り返し
であると分析しました。 しかし、手順書にはその構造を無視して書かれていることがあります。
たとえば、iPhone で Twitter のプッシュ通知を消したいという目的のケースを考えてみましょう。

「Twitterのプッシュ通知を正しく設定します。」

これは手順書としては 10点満点中 2点です。
なぜなら、操作対象である「プッシュ通知」がどこのメニュー項目にあるのか知らない人にとっては、
複雑なメニューの中をすべて、または分類項目から推測して探さなければならないからです。
そういう設定項目があるという情報だけでも何か解決することがあるかもしれませんが、
操作方法を知りたい人にとっては、この答えは、答えになっていません。

次に、具体的な操作手順を説明した文書はどうでしょうか。

「サンドイッチメニューから左下にある設定とプライバシーをタップして通知を選んで
プッシュ通知のメニュー項目を選びます。」

これは手順書としては 10点満点中 5点です。
なぜなら、手順書を見ながら操作することが、見知って、探して、操作する、の繰り返しで
あることのうち操作対象が何であるかは、文を読んで理解しなければ知ることすらできないからです。
しかもIT系の説明書は、知識をひけらかすような抽象概念の説明が多くされるため、
それと区別がしにくいからです。

また、操作対象が、サンドイッチメニュー、設定とプライバシー、通知、プッシュ通知という
ことは読めば分かると思われるかもしれませんが、
設定という操作対象と、プライバシーという操作対象に
分かれているとも読める曖昧さを含んでいるので良くありません。

また、自然言語だけで説明すると、繰り返し表現を避けるというルールの
壁にぶつかります。 たとえば、連続した「の」を避けるように注意されるので、
「設定とプライバシーの通知のプッシュ通知」という表現は使えません。
区切りが「の」に統一されていて理解しやすいのですが、
それぞれの「の」の違いについて言葉にするように要求されます。
そしてその要求通りに文書を直しても、自然に読めるようになるだけで
理解が早まるわけではありません。

また、同じ操作の動きに対して、タップすると言ってみたり、選択すると言ってみたりします。

このように、文系的に良い文書は、5点を越えることが不可能なのです。
営業トーク的な文書では大事なことですが手順書としては適しません。

メニュー項目の位置をスクショで示していたら、プラス 3点して、合計 8点です。
サンドイッチメニューが何かをスクショから知ることができますし、
文書とスクショという繰り返しが見えます。
ただし、スクショは作るのに少し時間がかかりますし、手順書の ファイル サイズ が
大きくなることや、バージョン管理が難しいといった問題があるので、
必要なスクショだけにします。
動画がベストかもしれませんが、「動画の7:58を見てください」
と手順書に書かれていたら、動画の途中に飛ばす操作に時間がかかります。
(動画サイトの途中から再生するURLが使えれば一瞬ですが)

次に、区切り記号を操作ステップに合わせて書いてみます。

「三(左上)>> 設定とプライバシー(左下)>> 通知(中央)>> プッシュ通知(中央)」

これは手順書としては 8点です。
見知って、探して、操作する、の繰り返しにおける、「見知って」に関しては、
カッコの外の数語を見るだけで知ることができます。
自然言語だけで書かれているより見つけやすいです。
「三」は文字的にサンドイッチメニューではないですが、操作するときに画面の左上を
注目して見るので気づくでしょう。正しくなくても伝わります。
「探して」に関しては()の中の上下左右によって見つけやすいです。
「操作する」に関しては、見分けやすい区切り記号によって、
4つの操作ステップがあることが分かりやすいです。

区切り記号 >> はパンくずリストとして標準的な記号であり、
それぞれの要素はページに対応していますが、
手順書では操作の 1つに対応させるのが良いです。
少し難しいので、例を交えて説明します。

メニュー項目を長押しする操作や、右クリックする操作を説明する場合、
操作対象と操作を区切り記号で区切らないようにします。

良くない: 通知 >> プッシュ通知 >> 長押し
良い:     通知 >> プッシュ通知(を長押し)

なぜなら、プッシュ通知をタップしてしまう可能性が高いからと、
長押しは操作対象として画面上を探すものではないからです。
また、操作内容は、操作対象として画面に見えるものではないので()の中に書きます。
ちなみに、プッシュ通知を長押しするという操作は Twitter にはありません。

設定項目のグループを文に含めたいときは、
グループと設定項目を区切り記号で区切らないようにします。
グループとは、大量のメニュー項目を探しやすくするために、
メニュー項目をいくつかのグループに分けたときのグループです。

良くない: 通知 >> 設定(グループ)>> プッシュ通知
良い:     通知 >>(設定の)プッシュ通知

なぜなら、グループ(設定と表示されているところ)に対して何か操作が必要ではないかと
迷わせてしまうからと、グループを意識しなくても設定項目の位置を何となくでも
覚えていれば、グループを探すことが不要だからです。
操作ステップ数が増えると覚えづらくなりますし。

「三(左上)>> 設定とプライバシー(左下)>> 通知(中央)>>(設定の)プッシュ通知(を長押し、中央)」

これで手順書としては 10点満点です。
区切り記号を使わない文だけの手順書を読む気になれないぐらい大きな差です。
スクショを加えても良いでしょうが、今回は探す対象が複雑ではないので不要です。


Sage Plaisir 21 のブログやツイッターを読もう!

Sage Plaisir 21 では、ここのホームページのほかにブログとツイッター も行っています。
ブログは、こちら。
ツイッターは、こちら。

Sage Plaisir 21 メールマガジンを読もう!

週刊 IT ニュース&コラム』には、 このページに掲載している コラムの他に、注目ニュースを集めたリンク集も、掲載しています。 日々多く集まる IT 情報から、注目すべき話題をコラム形式で取り上げますので、 ぜひチェックしておきましょう。 (サンプル、および登録)


Sage Plaisir 21 Contents
[ English | 日本語 ]

自動化ツールのダウンロード (2017-01-04) update!

急速な IT 革命により開発スピードの向上が課題になっています。 その鍵になるのがツールの活用または開発です。 一般的なものから専門的なものまで使えるツールを公開しています。

技術資料&オープンソース (2012-03-19)

扱う技術が多くなってくるにつれ、 技術はマスターするものではなく調べるものになり、 どれだけ実践に即した資料を集められるかどうかが、 勝負になります。標準的な技術の資料だけでなく、 プログラムソースやライセンスフリーのライブラリも公開しています。

オブジェクト指向プログラミング設計 (2000-04-01)

Visual Basic 7 にもついに本格的なオブジェクト指向の 機能が追加され、ソフトウェア技術者には必須の知識に なりつつあります。長年の研究の成果から、最新の応用方法まで 様々なメモを公開しています。

ソフトウェア・デザイン館より(技術エッセイ)   (2000-11-01)

プロの経験を通じて習得したソフトウェア全般に関する 技術を解説しています。 ソフトウェアとは何かといった根本的なことを通じて、 デザインに関するポイントをわかりやすく説明しています。


          
 ソフトウェア
デザイン館
Sage Plaisir 21

Simple and Visual

SagePlaisir21サーチ
パワード・バイ・グーグル

週刊 IT ニュース&コラム

7/19 区切り記号を操作ステップに合わせて入れると探しやすい - 構造化文書 (2)

6/28 Windows 11 を発表

6/6 メニュー項目の場所を上下左右で示すこと - 手順メモ (1)

5/16 GitHub のアカウント認証からパスワード認証が廃止へ

4/26 Jest の watch モードで Visual Studio Code のデバッガーを一瞬で再起動させる方法

4/5 LINE のトーク内容が中国企業で閲覧可能だった問題

3/15 cypress で期待通りに自動テストが動かなかったときの対策集

2/22 新型 コロナ ウィルス 感染経路特定アプリ COCOA の不具合放置問題

2/1 cypress を使って自動テストを簡単に導入する方法

1/11 ソフトウェアエンジニア40年のキャリアから学んだ 6つのアイデア

12/21 リセット状態の Windows から Jest + TypeScript + React + Visual Studio Code を確実に構築する手順

11/30 Apple Silicon がインテルや ARM の性能を大幅に超える結果に

11/9 チュートリアルや手順書を手軽にするプレースホルダーの書式

10/19 ドコモ口座から不正な引き出し、スマホ決済会社はセキュリティを軽視

9/28 したくない作業でもするようになる 5分スイッチ テクニック (4)

9/7 30%の手数料を支払っていないとしてアップルが Epic Games の Fortnite を削除

8/17 したくない作業でもするようになる 5分スイッチ テクニック (3)

7/27 Linux と Apple が人種差別的な用語を包括的な用語に置き換えると発表

7/6 したくない作業でもするようになる 5分スイッチ テクニック (2)

6/15 GitHub と MySQL を組み合わせたサーバー DoltHub

5/25 したくない作業でもするようになる 5分スイッチ テクニック (1)

5/4 Apple と Google が新型コロナウイルス感染者を追跡するシステムを発表

4/13 手続き型プログラミング言語で宣言型プログラミングをする(2)

3/23 新型コロナウィルスの影響でリモートワークの仮導入が進む

3/2 手続き型プログラミング言語で宣言型プログラミングをする

2/10 飲食店や病院などの予約システムをクラウドで簡単に作れる SELECTTYPE

1/20 コメントを書かずに概要を説明する方法 - リーダブル コード(61)

12/30 書くスペースを半自動的に作ってメモをしやすくする SpaceInk

12/16 手続き型プログラミングと宣言型プログラミングを使い分ける

12/2 ヤフーとLINEが経営統合して、あらゆる決済ができるスーパーアプリを提供へ

11/18 Linuxによくある謎の記号による処理を説明変数で読みやすくする方法

11/4 アップルが HKmap.live を香港デモを支援するアプリと判断し配信停止

10/21 エラーが発生したときに例外を投げずに返り値としてエラーを返したときの問題

10/7 暗号化PDFを開こうとパスワードを入力すると流出する脆弱性

9/23 Go 言語でよく defer される Close 関数のエラーを捕まえる

9/9 多くの Web サービスのインフラを提供している aws に障害発生

8/26 POSIX の ls コマンドで表示される一覧の区切りの空白は2文字

8/12 Google が Chrome のシークレットモードで有料記事を無料で読める機能を強化

7/29 プログラムとしての定数と仕様としての定数を明確に分けること

7/15 電子決済サービス開始で再び不正利用。7pay の対応の問題とは

7/1 インストール手順にバグがある原因は、スクリプトを作っていないから

6/17 音楽権利情報処理にAWSのブロックチェーン技術が採用される

6/3 インストーラーでインストールする対象のバージョンは、最新版より特定版

5/20 PC上での共同作業をインテリジェンスにする Fluid Framework

5/6 Windows で Python スクリプトを Python の仮想環境の中で起動する方法

4/22 Windows で USB デバイスの安全な取り外しの操作が不要に

4/7 ブール型の説明変数の名前は文にする - リーダブル コード(60)

3/25 グーグルがゲーム ストリーミング サービスに参入、STADIA を発表

3/11 ソースコードが早く読めるようになる、シンプルコメント2 - リーダブル コード(59)

2/25 無料で使えるように改変した iOS アプリを何者かが配布

2/11 ソースコードが早く読めるようになる、シンプルコメント2 - リーダブル コード(58)

1/28 5月1日から変更される新元号の名前の発表が 4月1日に決定

もっと前の記事

自動化ツールのダウンロード

Snap Note 3 mini - サクサク使える自由ノート  new!

Plastic Window 1.20 - ウィンドウを半透明に  new!

Shortcut Director 1.00 - ショートカットのリンク切れ修正

Archives Folderizer SV 1.10 - 圧縮解凍

デジタルスクラップブックSVG Cats 2

その他のツール

オブジェクト指向プログラミング設計

技術資料

All Text composed by T's-Neko ts-neko@sage-p.com,