それには少し同意しかねます。作成できるヘルプコンテンツにはさまざまなスコープがあります。Diátaxisモデルに従うと、チュートリアル、ハウツーガイド、リファレンス、説明があります。
チュートリアルはおそらくアプリ自体にリンクする場所があり、たとえば「これがどのように機能するかを学びたい」という意図でページに入った場合、そのページが自己説明的でなくても学ぶことができます。ソフトウェアのコースを完了できるチュートリアルセンターさえあるかもしれません。
他の3つのカテゴリについては、少し問題があります。
カテゴリ設定ページにアクセスすると、20個の異なる操作を行いたい場合があります。そこにハウツーガイドを配置すると、検索する必要のあるリストになり、探しているものが必ずしも専用のハウツー記事になるとは限らないという期待があるため、リストを検索するのではなく、Googleでその質問を入力する可能性が高いです。
オフサイトのリファレンスは、私が毎日対処しなければならない厄介なものです。「リファレンスマニュアル」があり、スライダーやボタンの各機能が次のように説明されています。
キャンセルボタン: 変更を適用せずにダイアログを閉じます。
OKボタン: 変更を適用してダイアログを閉じます。
このリファレンスを使用すると、セクションに到達する前に多くの技術的な内容をスクロールする必要があり、実際には数語でオプションを言い換えるツールチップが必要だったのに、ということになります。
カテゴリを削除しようとすると、現在の動作はほぼ望ましいものです。ボタンが表示され、通常はグレー表示されていますが、疑問符が付いており、クリックすると次のように表示されます。
このカテゴリはサブカテゴリがあるため削除できません。
または:
このカテゴリには25852個のトピックがあるため削除できません。最も古いトピックは…
動作は良好で、何が問題で、次のステップは何かがわかります。投稿やサブカテゴリを大量に削除する必要があります。「カテゴリを削除する」ハウツーガイドをアプリにリンクしても改善されません。
もちろん、これは根本的な問題に対する応急処置にすぎません。なぜ投稿が含まれているカテゴリを削除できないのでしょうか? システム上のサブフォルダやファイルを含むフォルダを削除できますが、サブカテゴリや投稿を含むカテゴリを削除できないのはなぜですか?これらの奇妙な制限がなければ、そもそもアプリにハウツーガイドが必要になることはありません。
そして最後に、説明です。これは「信頼レベルの理解」というブログ記事です。初めてこれに出会ったとき、それはかなり混乱していました。「6年前のランダムなブログ記事が、あなたが持っている最高のドキュメントなのですか?」そして、それはリファレンス記事にリンクされており、すべてをテーブルにリストアップしていますが、これは私が期待していたもの(ただし、期待していた方法では並んでいませんでした)に近かったです。説明はタスクを直接理解するのに役立たないため、タスクが完了する場所に配置してもあまりうまくいきません。
最終的に、ドキュメントはいくつかの場所(たとえば、オンボーディングやデザインが失敗した場合)で重要ですが、主にデザインに焦点を当てるべきだと思います。誰かがウェブサイトを説明するのを読んだりビデオを見たりすることは、めったに望ましい経験ではありません。