ドキュメント読了時間計算ツール

コードやスクリーンショットを含むドキュメントの、現実的な読む時間がわかります。

ブラウザ内で動作
アップロード不要
アカウント不要

このツールは英語のテキストを分析します。

ブラウザツールを読み込んでいます…

ドキュメント読了時間計算ツールでできること

コードサンプルが 3 つ、スクリーンショットが 4 枚ある開発者ガイドは、単語数から想像するより読むのに時間がかかります。ここに Markdown のページを貼り付けると、3 つの要素を合計して見積もります。1 分あたり 200 語の本文、コード 1 行につき 3 秒、画像 1 枚につき 12 秒です。

タイルにはそれぞれの要素が別々に表示されるので、時間が説明文にかかっているのか、長い設定サンプルにかかっているのかがわかります。フェンスとインデントによるコードブロックのコードは、単語ではなく行で数えます。Markdown の画像と HTML の img タグの画像を数えます。コードと画像の時間は「その他のオプション」で変更できます。コードのない普通の記事なら、読了時間計算ツールで十分です。

例

入力

## Install the CLI
Run the installer, then sign in with your workspace token. The command prints your workspace name when it works.

```bash
npm install -g example-cli
example login
example whoami
```

![Terminal after sign-in](https://example.com/cli.png)

結果

Reading time: 0:29 (about 1 minute)
Prose: 0:08 (26 words at 200 wpm)
Code: 0:09 (3 lines)
Images: 0:12 (1 image)

テキストは 26 語しかありませんが、コードとスクリーンショットが読む時間の 3 分の 2 以上を占めています。

ドキュメント読了時間計算ツールの使い方

Markdown のページを貼り付けるか、「ファイルを開く」で .md ファイルを読み込みます。
「読む速さ」を選び、「その他のオプション」を開いて「コード 1 行あたりの時間」と「画像 1 枚あたりの時間」を設定します。
「読む時間」のタイルと、「本文」「コード」「画像」の内訳を確認します。

知っておきたいこと

コードブロック内の空行は数えませんが、それ以外の行は、1 語のコマンドでも長い設定行でもすべて同じに数えます。
画像として数えるのは、Markdown の画像構文と img タグだけです。埋め込み動画、iframe 内の図、表には時間が加算されません。
文中のインラインコードは、コードの行ではなく本文の単語として数えます。

ドキュメント読了時間計算ツールについてよくある質問

ドキュメントの 1 ページは、どれくらいの時間で読める長さがよいですか？

作業手順のページの多くは 2〜5 分が最適です。読み手はたいてい 1 つの作業を終えるために来るので、10 分以上かかるページは複数の作業を扱っていることが多く、互いにリンクした別々のページに分けたほうが使いやすくなります。

ドキュメントのページに読む時間を表示すべきですか？

チュートリアルや長いガイドでは役立ちます。読み手は最後まで読む時間があるかを知りたいからです。短いリファレンスページでは、表示が邪魔になります。表示する場合は、コードと画像を含めた見積もりを使ってください。単語だけでは技術的なページの時間を少なく見積もってしまいます。

コードを読むのにはどれくらいかかりますか？

単語あたりで比べると、本文よりはるかに長くかかります。読み手は構文を確認し、各行が何をするのかを考えるからです。見慣れたコードなら 1 行あたり数秒が妥当な平均です。複雑なサンプルや、その言語に不慣れな読み手向けには、1 行あたりの時間を増やしてください。