明確性向上のための文書再構築

:white_check_mark: 更新 (2024年6月4日): ドキュメントのトピックの再構築に関する初期作業が完了し、新しいカテゴリが現在公開されています。各カテゴリに何が含まれているかを示す新しいインデックスも用意されています。こちらから確認できます: Documentation - Discourse Meta - 不正確な箇所が見つかった場合は、このトピックに投稿してください!

現在のドキュメント構造を徹底的に見直した結果、コミュニティが達成しようとしている目標に焦点を当て、トピックをより整理されたものにするために、ドキュメントの分類を改善する作業を進めていることをお知らせできます。私たちの目標は、ドキュメントの明確さと使いやすさを高め、誰もが必要な情報を簡単に見つけられるようにすることです。

期待されること

:label: 新しいカテゴリ

今後、ドキュメントは、それが記述しているアクションや機能に基づいてカテゴリ分けおよびタグ付けされます。現在のユーザー役割に基づくグループ分けは廃止され、各トピックが記述する活動を行うために必要なユーザー役割を示すように、すべてのドキュメントトピックを更新します。

:eyes: 一時的な外観の変更

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

:white_check_mark: 包括的な更新

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

支援の方法

皆様からのフィードバックは、いつも私たちにとってかけがえのないものです。問題を見つけた場合や、ドキュメントをさらに改善するための提案がある場合は、Contribute > 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