新しいドキュメンテーションプラグインが開発中

新しいドキュメントプラグインのテストとフィードバック提供を開始しました。このプラグインは、Discourseでホストされているドキュメントのナビゲーションとアクセシビリティを強化し、すべてのユーザーにとってよりアクセスしやすくフレンドリーな体験を提供することを目的としています。このプラグインはまだ開発中であることに注意してください。

このプラグインの開発は、ドキュメントの改善に向けた継続的な取り組みから生まれました。この取り組みは、新しいサイドバーによってすでに強化されています。サイドバーの作業は、大幅に改善されたドキュメント体験の基盤を築き、新しいプラグインは、その作業を段階的に積み重ねています。

:boom: 新しいプラグインの動作

現在、このプラグインはアクティブであり、公式Discourseドキュメントのドキュメントを強化しています。ぜひその機能を探求し、ご経験を私たちと共有してください。皆様からのフィードバックは、プラグインの改善と強化に不可欠です。

新しいプラグインに含まれる主な機能は次のとおりです。

  • ドキュメントに使用するカテゴリを定義するための設定
  • 各カテゴリ内のインデックストピックによって入力される新しいドキュメントサイドバー
  • インデックストピックの整合性と正確性を維持するための2つの新しいレポート

継続的な機能改善のため、さらに多くの機能が開発中です。

新しいプラグインは、本日よりダウンロードおよびインストール可能です: Discourse Doc Categories

:electric_plug: Discourse Docsプラグインからの移行

イノベーションと前進に伴い、古いDiscourse Docsプラグインは廃止する予定です。しかし、新しいプラグインが広くリリースされるまで、引き続きサポートいたしますのでご安心ください。また、新しいプラグインは古いプラグインからのURLリダイレクトを確実に処理するため、切り替えによるリンク切れは発生しません。

新しいプラグインはまだ実験段階であることをご了承ください。シームレスな体験を提供することを目指していますが、さらなる改善が必要な領域がある場合があります。皆様からの建設的なフィードバックは、その成功に不可欠です。

:speaking_head: ご意見をお聞かせください

皆様からのご意見、ご経験、フィードバックをいただければ幸いです。Metaのドキュメントをナビゲートしたり、ご自身のサイトにプラグインをインストールしたりして、新しいドキュメントプラグインの使用中に得られたご経験や洞察をぜひ共有してください。

私たちの目標は、Discourseコミュニティ全体のドキュメント体験をより良くすることですので、すべてのフィードバックを歓迎します!

プラグインの詳細はこちらでご覧いただけます:

「いいね!」 13

README を更新する必要があります。また、この問題を防ぐために lint ルールを更新することも検討してください。ただし、鶏と卵の問題があります。

Discourse を LMS として使用するのにも適しているようです。その場合、どのカテゴリをドキュメントカテゴリにするかを切り替えられると良いでしょう。ただし、ユーザーに特定のカテゴリへのアクセス権を付与する権限を使用するだけで十分機能する可能性が高いです。

「いいね!」 8

URLの指摘ありがとうございます。追加するPRを提出したばかりです。

これは興味深いユースケースですね。うまく機能すると思います!

「いいね!」 6

これは、元のドキュメント/ナレッジベースプラグインと比較して素晴らしい改善です。今のところ非常にユーザーフレンドリーのようです。

Metaでのテストは間違いなく大きなプラスです。以前はドキュメントのカテゴリから物事を見つけるのが難しかったからです。

「いいね!」 5

ETAを伺ってもよろしいでしょうか?つまり、このプラグインが実験的な段階を脱し、ベータ版、あるいは早期リリース候補版の段階になるのはいつ頃になるでしょうか?未来を予測するのがいかに難しいかは承知しておりますので、どんなに不正確でも、おおよその見積もりで満足いたします。 :wink:

現在、職場でDiscourseをツールとして検討しています。その理由は、コミュニティでの議論と、ドキュメント共有スペースの良い組み合わせを提供できると思われるからです。ドキュメントの作成が、トピックへのコメント投稿と同じくらい簡単なのです。

そのため、ウィキのトピック機能自体は素晴らしいスタート地点ですが、このプラグインはトピックの内容に一貫性を加えるものであり、ドキュメントのユーザーエクスペリエンスに不可欠だと信じています。

meta.discourse.orgのドキュメントカテゴリは、単にカテゴリを共有し、Discourseの仕組みを説明しているだけのランダムなフォーラムトピックではなく、適切な構造化されたドキュメントサイトのように感じられます。

これからも頑張ってください。ありがとうございます!

「いいね!」 1

とても気に入りました!ドキュメントとディスコースは非常によく合っています。

カテゴリに加えて、タグのインデックス作成を有効にする予定はありますか?

現状は「美しさ(あるいはその欠如)は見る人の目の中にある」という段階だと思います。

これは、特にドキュメントやインデックスのメンテナンスを担当するユーザーにとって、既知のUXの問題があるという意味で実験的ですが、本番環境での使用は完全に安全です。

つまり、実際に試してみて、ご意見をいただけると大変ありがたいです。

インデックスメンテナンスにおける既知のUXの問題を改善するETAは現時点ではありませんが、ユーザーからのフィードバックがその方向性を推進するのに役立つかもしれません。

いいえ、これはこれまでどこでも話題に上がっていません。どのようなことを考えているのか、あるいはなぜこれが役に立つのか、もう少し詳しく教えていただけますか?

「いいね!」 4

これについて:ドキュメントカテゴリにいるときに、全画面表示ではないチャットウィンドウを閉じると、ドキュメントナビゲーションも「閉じられ」、通常のナビバーが表示されます。メタで再現する際に、ヘッダーの右上にあるチャットバブルをクリックすると、ドキュメントナビゲーションも閉じられることに気づきました。お役に立てば幸いです!

「いいね!」 3

ご報告ありがとうございます。再現できたため、これを記録し、今後の開発作業に含めます。

「いいね!」 3

それはDiscourseというプロジェクトについて、ユーザーである私にとってあまり理想的ではないことが一つ思い浮かびました。バグや計画のための適切な公開課題追跡システムを使用していないという事実です。

例えば、Hughの返信を読んだとき、私の内部プロジェクトマネージャーはすぐに「どこに、どこに記録されたのですか?」という疑問を抱きました。私の内部PMはとても詮索好きで、そうではありませんか? :slight_smile:

meta.discourse.orgを課題追跡システムとして使用することは、Discourse自体を「ドッグフーディング」する機会を与えていると思います。そして、他のすべての課題追跡システムには独自の欠点があるので、一つを選ぶのは苦痛です。しかし、私にとってDiscourseは、質問や議論のためのフォーラムとしては優れていますが、課題追跡システムとしては非常に不足しています。その目的のためには、効果的なカテゴリ分け、影響を受けるバージョンや対象バージョンに関する情報、課題番号、優先順位付け、ステータス、経過時間、優先順位、製品またはコンポーネントで課題をフィルタリングする効果的な手段、そして機能または製品全体のマッピングを提示する良い方法などが不足しています。

まあ、話がそれてしまいました。そして、私はまだ一行のコード、バグレポート、または機能リクエストさえ貢献していないので、文句を言う資格はありません。 :wink:

改めて、Discourseの素晴らしさについて、皆さんありがとうございました。そして、半ば愚痴のようなことをお許しください。

そして、本題に戻ると、Discourse Doc Categoriesがまだ洗練されていないものの、建築的に安定していると考慮されていることを聞いてよかったです。ホストされているDiscourseインスタンスにインストールできるかどうかを確認し、もし可能であればフィードバックを返すようにします。ありがとうございます!

「いいね!」 6

ここで返信するのを忘れていました。フォローアップありがとうございます。

#wikicommunity support dev のようなさまざまなカテゴリに適合し、ユーザーのトピックの関心に基づいてデータを表示する方が良いことを理解しています。

一方、それらの wiki をドキュメント(wiki サイドバーリンク)に整理して表示するのは素晴らしいですね。

「いいね!」 1

私たちは Discourse を課題追跡システムとして使用しています。より正確には、チームに Discourse を課題追跡システムとして使用させようとしています :slight_smile: また、Wiki、フォーラム、ドキュメントとしても使用しています… CDCK チームは、誰も持っていない興味深いプラグインを使用して、内部で作業を追跡する別の「秘密の」Discourse サイトを持っていると疑っています。

ここの課題追跡システムがどれほど優れていても、コミュニティは私が知っている他のものとは比較になりません。結局のところ、ソフトウェアを開発するのはテクノロジーではなく、人々です。そして彼らは素晴らしいです! :metal:

ドキュメントプラグインもとても気に入っています。 :heart:

このように褒め称えた上で、私の PR を承認していただけませんか? :smiley:

「いいね!」 5

Gerhard がそのPRで回答したのを見ましたか?

「いいね!」 3

内部で使用している別のサイトは確かにありますが、それは秘密のプラグインを使用しているわけではありません。

主に、「todos」のカテゴリや、現在/次/後で優先順位を付けるための標準的なタグセット、そして担当者を明確にするためのassignプラグインのような規約を使用しています。

これにより、kanbanテーマコンポーネントも機能しますが、誰もがそのビューを使用しているわけではありません。

非常に流動的で、非常に意見の強い課題追跡ツールではありませんが、私たちにとってはうまく機能しています。

いつかさらに詳しい情報をお伝えできるかもしれません…

「いいね!」 6

いいえ!私のミスです。修正しました。お知らせいただきありがとうございます。

「いいね!」 3