ドキュメントの再構成による分かりやすさの向上

:white_check_mark: 更新(2024年6月4日): ドキュメントトピックの再構築に関する初期作業が完了し、新しいカテゴリが利用可能になりました。新しいインデックスで、各カテゴリに何が含まれているかを確認できます。こちらからご確認ください:Documentation - Discourse Meta - 不正確な点に気づいた場合は、以下に投稿してください!

現在のドキュメント構造を徹底的にレビューした結果、コミュニティが達成を目指している目標に、より整理され、焦点を絞ったトピックにするために、ドキュメントのカテゴリ分けを改善するプロセスにあることをお知らせできることを嬉しく思います。私たちの目標は、ドキュメントの明確さと使いやすさを向上させ、誰もが必要な情報を見つけやすくすることです。

期待できること

:label: 新しいカテゴリ

今後、ドキュメントは、それが説明するアクションまたは機能に基づいてカテゴリ分けされ、タグ付けされます。現在のユーザーロールに基づくグループ分けは廃止され、すべてのドキュメントトピックを更新して、それが説明するアクティビティを実行するために必要なユーザーロールを示します。

:eyes: 一時的な視覚的変更

この再構築中に、ドキュメントの一部のセクションが少し場違いに見えたり、整理されていないように見えるかもしれません。心配しないでください!これは、新しい構造を最終決定するための作業中であるため、一時的なものです。

:white_check_mark: 包括的な更新

再構築が完了したら、次のステップは、新しい共通のスタイルガイドに沿ってすべてのドキュメントトピックを更新することです。また、存在する可能性のある不正確な点も修正します。これは継続的なプロジェクトであり、作業の大部分は今後数週間で行われます。

協力方法

いつものように、皆様からのフィードバックは非常に貴重です。問題が発生した場合、またはドキュメントをさらに改善する方法について提案がある場合は、Site feedback で、またはこのトピックに投稿して、遠慮なくご意見をお聞かせください。

これらの変更を行う間、ご協力いただきありがとうございます!

「いいね!」 14

モデレーションに関するトピックは、Discourse Moderation Guide のようなものは Documentation > Site Management に含まれます。「サイトオーナーと管理者」のカテゴリのトピックをモデレーターとして確認しない可能性があるので、説明に追加すべきかもしれません。

「いいね!」 3

モデレーターにとっても役立つことを示すために、アバウトテキストに小さな変更を加えました。

@JammyDodger および/または @hugh も、後でこれを見たときにさらに意見があるかもしれません。

「いいね!」 2

さらに微調整しました。

「いいね!」 4

@Moin!ご指摘ありがとうございます!

@JammyDodger 確認しましたが、あなたのアップデートは問題なさそうです。

ドキュメントトピックの再構築の初期作業が完了し、新しいカテゴリが新しいインデックスとともに公開されました。これにより、各カテゴリに何が含まれているかがわかります。

こちらで確認できます: Documentation - Discourse Meta - 不正確な点に気づいた場合は、以下に投稿してください!

「いいね!」 1

ドキュメントプラグインに新しいカテゴリを追加する予定はありますか?

「いいね!」 1

ドキュメントプラグインを導入しない場合と導入する場合とで迷っています。:slight_smile: とりあえず、新しいカテゴリを追加しました。:+1:

「いいね!」 3

投稿が既存のトピックにマージされました: 新しいサイドバーによるドキュメントナビゲーションの改善

サイドバーのサブカテゴリ内のトピックへのリンクのテキストはどのように作成されますか? AIですか?

「いいね!」 1

各サブカテゴリにはインデックストピックがあります。例:Using Discourse Index (これらは各サブカテゴリのヘッダーの説明からリンクされています)。

サイドバーは、そこから短縮されたタイトルを取得して、完全な記事タイトルの代わりにそれらを使用します。

「いいね!」 3