ドキュメント貢献の機会

サイトフィードバック
,
1

Discourse のドキュメントは、管理者、モデレーター、ユーザー、システム管理者が Discourse の使用方法やサイトの管理方法に関するヘルプを見つけるための主要な場所です。

このドキュメントは堅牢で多くの分野をカバーしていますが、まだ文書化されていない領域がいくつかあります。これは、コミュニティがこの重要な Discourse プロジェクトの一部を改善するのに役立つ素晴らしい機会です。

より多くの人々が Discourse のドキュメント コンテンツの作成に参加することを望んでおり、誰でも簡単に参加できるようにしたいと考えています。そのために、以下に、新しいまたは改善されたドキュメントが必要であると特定した Discourse の機能またはユースケースのリストを示します。

:notebook_with_decorative_cover: ドキュメントの場所

信頼レベル 2 以上のユーザーは、Community wiki で新しいドキュメント トピックを作成できます。ここは、コミュニティが提供したすべてのドキュメント コンテンツのホームです。コミュニティ wiki のトピックが関連性がある、または重要であると見なされた場合、公式の Discourse ドキュメントのホームである Documentation に移動される場合があります。詳細については、ドキュメント ポリシーをお読みください。

:gift: ドキュメント作成者向けのバッジ

Community wiki カテゴリに新しいトピックを作成したユーザーは、自動的にブロンズの Scribe バッジが割り当てられます。

Scribe badge
Scribe badge714×284 10 KB

トピックが公式の Documentation カテゴリに移動するのに十分な価値があると見なされた場合、Discourse チームの誰かが手動で移動し、元の著者にトピック コンテンツでクレジットを与え、シルバーの Ghostwriter バッジを割り当てます。

Ghostwriter badge
Ghostwriter badge714×330 17.6 KB

:eyes: 作成する必要があるドキュメント

最終的には Discourse のすべての部分が徹底的に文書化されることを望んでいますが、最も緊急のニーズがあると特定した分野は次のとおりです（取り消し線が引かれた項目は、この投稿が最初に公開されてからトピックが作成されたことを示します）。

  • 管理者向けの一般的な開始チュートリアル
  • カスタム トピック リダイレクト
  • さまざまなユーザー レベルができることの説明
  • ソーシャルログイン オプション
  • 通知の投稿 (公式ドキュメント)
  • 信頼レベルの仕組みに関する詳細なドキュメント
  • Discourse の優れた機能リクエストの書き方 (wiki トピック)
  • Discourse のマークダウンや書式設定機能がメールに含まれる場合にどのように表示されるかのリファレンス
  • ユーザー ステータス (wiki トピック)
  • ダーク モードの説明、選択方法、切り替えの有効化方法 (wiki トピック)
  • ユーザー設定の管理に関する一般的なドキュメント (wiki トピック)
  • Discourse におけるカテゴリと階層の仕組みを説明するドキュメント
  • トピック設定の一般的なガイド
  • プラグインに関する一般的なガイド - それらが何であるか、どのように機能するか、どのように使用するか
  • カスタム ホームページ
  • デフォルトのカテゴリとトピックの変更
  • 投稿での画像グリッドの使用 (wiki トピック)
  • 投稿承認設定 (wiki トピック)

これらのいくつかは、効果的に文書化するために複数のトピックが必要になる場合があります。

:pencil2: ドキュメントの書き方

Discourse のドキュメントが可能な限り効果的であることを保証するために、このコンテンツの書き方に関するスタイル ガイドがあります。誰もがガイドに従うと役立ちますが、Community wiki に貢献している場合、完全にそれに従わなくても問題ありません。Documentation に移動されたトピックは、必要に応じて Discourse スタッフによってスタイル ガイドに一致するように更新されます。

:bulb: 興味がありますか？

Community wiki に参加して、今日から文書化を始めましょう。これらについて話し合いたい場合は、このトピックに返信してお気軽にお話しください。

「いいね！」 12
8

既存のトピックについてはどうですか？例えば、

「いいね！」 4
9

For this one:

The existing documentation talks about how to request new features, but not how to format a good request to make it more effective. We currently link to this page, but it would be good if we could have that kind of content on Meta instead.

And for this one:

Good catch! I’ll remove that from the list in this topic :slight_smile:

これについては：

既存のドキュメントには新機能のリクエスト方法が記載されていますが、効果的なリクエストを作成するためのフォーマットについては記載されていません。現在、このページをリンクしていますが、代わりにメタにそのようなコンテンツがあると良いでしょう。

そして、これについては：

良い指摘ですね！このトピックのリストから削除します :slight_smile:

「いいね！」 3
10

すでに機能リクエストをカバーするこのトピックがあります

それとも、機能リクエストのためにこのように見える必要があるのでしょうか？ :point_down: :eyes:

「いいね！」 4
11

これはスタッフ通知、それとも何か別の意味ですか？

「いいね！」 1
12

これはタイトルにあるように、投稿通知だと思われます。

スタッフ通知も基本的に同じようなものだと思いますか？

「いいね！」 3
13

はい、それが探しているものです :slight_smile:

@ondrej がリンクしたように、投稿通知はこの告知で概説されているものです。その告知トピックはありますが、それに関する実際のドキュメントはありません。

「いいね！」 4
16

ヒュー、素晴らしいアイデアですね。

コミュニティウィキに、フォーラムテンプレートのようなものにタグを付けるというアイデアを提示したいと思っていました。

このアイデアはこうです。Discourseをサポートフォーラム、学習プラットフォームなどに使用する方法について質問する人がよくいます。時には、テーブルトップRPGのような、よりマイナーな用途もあります。

そのようなトピックからのコンテンツを集め、さまざまな用途を考えることで、マスターとなるトピックをインデックスとして使用する新しいリソースを作成できます。

  • サポートフォーラムテンプレート
  • 学習プラットフォームテンプレート

これらのトピックは、Discourse、Communique（？）などでホストされ、推奨されるプラグインやテーマコンポーネントなどを収容できます。また、セルフホスト用の投稿もあります。

ホスト型テンプレートは、プラグインに焦点を当て、特定のプラグインの使用に必要なプランを参照します。

ヒントやコツを提供し、カスタムレイアウトやプラグインなどが必要な場合は、Marketplace に誘導することもできます。

「いいね！」 3
18

作成しました：

「いいね！」 7
19

それを見ました :smile: これらが届くのを見るのは素晴らしいことです！

「いいね！」 8
21

ダークモードの作業中です。

「いいね！」 5
22

これらのガイドはすでに作成されていますが、まだチェックされていません。

これは少し曖昧です。カスタムホームページのコンテンツを指していますか？もしそうなら、おそらく https://meta.discourse.org/t/add-custom-content-that-only-appears-on-your-homepage/131415。そうでなければ、まだ書かれていません。

「いいね！」 2
23

ここに戻ってきてくれてありがとう。OPをこれらのリンクで更新しました。

これはかなりニッチなもので、カスタムホームページの作成を指しているため、ほとんどのDiscourse管理者があまり使用しないものです。現時点では完全に洗練されたものではないため、主要な機能ではありません。

「いいね！」 2