効果的な機能リクエストの書き方:段階的ガイド

要約

このドキュメントトピックでは、Discourseで機能リクエストを作成する方法について、ステップバイステップガイドで解説します。

ステップ1:開始する前に

Discourseの機能に関する素晴らしいアイデアをお持ちですか?それは素晴らしいことです!チームやコミュニティに効果的に共有する方法を以下に示します。機能リクエストを送信する前に、既存のディスカッションを検索して、あなたのアイデアがすでに提案または実装されていないか確認してください。これはいくつかの方法で行うことができます。

  • Feature カテゴリを確認する
  • ページ右上隅の:mag:アイコンをクリックして、検索を表示します。カテゴリとタグでフィルタリングするために高度なフィルタを使用できます。
  • pr-welcome タグが付いたトピックを確認する - PRとはGitHubのプルリクエストのことで、開発者がプロジェクトに新しいコードを導入する方法です。
  • completed タグが付いたトピックを確認する
  • Plugin カテゴリを確認する

あなたの機能提案がすでにリストされている場合は、それを支持するために投票してリクエストを目立たせたり、いいねを付けたり、追加のアイデアやユースケースを返信したりすることで、その有用性と機能を追加すべき理由をさらに伝えることができます。

あなたのアイデアに関する言及が見つかりませんか?機能リクエストを作成できます。


ステップ2:基本

タイトル
トピックのタイトルは、情報を分かりやすく、かつ長すぎないようにすることが重要です。リクエストの範囲は一目で識別できる必要があります。

カテゴリ
新しいトピックを作成する際は、Feature カテゴリを選択してください。

タグ
タグは機能をグループ化および分類するために使用されます。リクエストを整理するために、トピックに適切にタグを付けることは、追跡のために非常に役立ちます。たとえば、chat プラグインに関連するすべてのものは、1つのタグの下にまとめられます。


ステップ3:リクエストの作成

優れた機能リクエストを作成することは重要です。これにより、Discourseチームは改善が必要な領域を迅速に特定できます。

機能リクエストを作成する際は、あなたのアイデアを売り込み、あなたの機能アイデアが十分に根拠があることを人々に納得させることを目指していることを忘れないでください。コミュニティ、あなた自身、そしてチームのために、なぜあなたの機能を追加してほしいのかを説明してください。

トピックの本文では、要求している機能を簡潔に述べます。具体的かつ詳細に記述し、曖昧またはオープンエンドな表現を避けてください。

コンテキストと説明を提供する

機能リクエストのコンテキストと説明を提供してください。

  • 要求している機能の明確な説明
  • 現在の苦労している問題またはユースケースと、あなたの機能がそれをどのように解決するかを含める
  • あなたが行った関連する背景情報または調査

例とスクリーンショットを提供する(オプション)

該当する場合は、例、モックアップ、またはスクリーンショットを提供して、機能リクエストを分かりやすくし、他の人があなたのアイデアを簡単に視覚化できるようにしてください。

コミュニティと交流する

機能リクエストを作成したら、質問やフィードバックに返信してメンバーと交流してください。これにより、リクエストが検討される可能性が高まります。

次に期待すること
機能リクエストを送信すると、コミュニティとDiscourseチームによってレビューされます。以下が期待できます。

  • コミュニティからのフィードバックとディスカッション
  • Discourseスタッフからの、リクエストが実現可能であり検討中であるかどうかの回答
  • 将来のアップデートでの機能リクエストの実装の可能性

機能が確実に実装されるようにしたいですか?

場合によっては、機能リクエストがコアに適さないことがあります。機能決定がどのように行われるかを読むことができます。自分で機能を開発できない場合でも、実装される可能性を高める方法はまだあります。

discourse.org の顧客になる

私たちと一緒にサイトをホストすることで開発に資金を提供したい場合は、開発タイムラインで顧客のリクエストを常に優先します。これが、より早く実装する1つの方法です。エンタープライズ顧客は、コアチームに時間単位の料金でカスタム機能(通常はプラグインの形式)をリクエストできます。

「pr-welcome」タスクにスポンサーする

包括的なpr-welcomeトピックのリストがあります。これらは、私たちが完了させたいと考えているタスクですが、現在自分で取り組むための帯域幅がありません。これらのタスクに取り組む人をスポンサーすることは、関与するための素晴らしい方法であり、Discourseへの貢献は高く評価されます。

マーケットプレイスでの有料作業を提供する

ビジネスにとって重要なプラグインが必要な場合は、#marketplace::categoryで有料の割り当てを宣伝してください。スクリーンショットや予算など、できるだけ多くの詳細を提供してください。「1回限りのインストール」や「パーソナライズされたテーマ」などの標準化されたマイクロサービスを提供するフリーランサーを見つけることもできます。


全体

一般的な「すべきこと」と「すべきでないこと」

すべきこと

  • リクエストを簡潔にし、単一の機能に焦点を当てる
  • 実装または技術的な詳細に関する仮定を避ける
  • コミュニティのフィードバックに基づいて、妥協しアイデアを適応させる意欲を示す

すべきでないこと

  • 1つのトピックに複数の機能を含める
  • リクエストの範囲について他人に疑問を抱かせる

よくある質問

Q: 詳細な機能リクエストを作成する時間がありませんか?
A: その場で詳細なリクエストを作成できない場合は、言いたいことを考えてから後で再度試してください。これにより、最善の主張を提示でき、他の人があなたのリクエストを支持し、追加される可能性が高まります。

Q: 機能リクエストはどこに投稿すべきですか?
A: 適切なカテゴリを使用してください - 機能リクエストは Feature カテゴリに投稿する必要があります。

Q: リクエストに使用するタグがわからない場合はどうなりますか?
A: タグは使いやすさのためにプラグインやテーマコンポーネント名と一致しますが、チームメンバーまたはレギュラーがトピックが空白のままの場合は適切なタグを追加します。

リクエストでは、敬意を払い、オープンマインドであるようにしてください。機能リクエストを使用して不満を表明することは避けてください。不適切な言語や行動は、リクエストの遅延または無視につながる可能性があります。

追加リソース

「いいね!」 13

これは、保留中の機能リクエストについてスタッフからの返信が期待できるということですか? :innocent: :sweat_smile: :smiley:

「いいね!」 2

それは、機能のほとんどのトピックにチームメンバーからの返信があったので書きました。あなたの機能リクエストは気に入っています :smile:

「いいね!」 2

これが最も重要なことの1つであり、しばしば十分な強調がなされていないと思います。

可能な限り具体的な言葉で、これについての理解を深めることは非常に役立ちます。

他の人が他の人の機能リクエストにコメントする際にも、私は通常この部分を探しています。なぜなら、人によって問題が少しずつ異なることが多いからです。

さらに、人々が現在その問題をどのように解決しているかを知ることも非常に役立ちます(例:現在の回避策や代替ソリューション)。

「いいね!」 5