トークンプロジェクトのための、より明確な GitHub 開発者プレゼンス

リポジトリに必要な支援の種類から始めましょう

GitHub プレゼンスのレビューは、アドバイス、コピーの改善、またはドキュメント作成支援に焦点を当てることができます。まず、どのリポジトリが重要かを合意します。また、訪問者に何を理解してほしいかも合意します。

公開資料に新鮮な目を必要とするチームもいれば、すでにギャップを見つけており、ドキュメントをより追跡しやすくするための支援を求めるチームもいます。以下の表は、開始地点を説明するのに役立ちます。作業は、必要に応じてこれらのオプションを組み合わせることもできます。

各リポジトリについて、読者の次に役立つステップを探します。読者はプロジェクトを理解し、関連ドキュメントを見つけ、または質問の方法を学ぶことができるべきです。不足している技術的事実は、推測で埋めるのではなく、メモします。公開前に、あなたの開発担当者が製品詳細を確認します。

公開コミュニティに、技術資料からの明確な引き継ぎが必要な場合は、この作業をコミュニティ成長とエンゲージメントに接続することもできます。目的は、リポジトリと、あなたのチームが実際に質問に答える場所との間の実用的な経路を作ることです。

注目が集まる前に、プロジェクトを追跡しやすくしましょう

明確なリポジトリ情報は、プロジェクトが議論されているときに、訪問者にとって役立つ開始点を提供します。短いレビューは、チームが混乱を招くリンク、欠落したコンテキスト、古い説明を見つけるのに役立ちます。これらの資料を広く共有する前に行うことができます。

ある若いトークンプロジェクトの運営責任者が、AMA の前夜に、プロジェクトリンクを開くと明確な開始点のないリポジトリが表示されることに気づいたと想像してください。私たちは公開経路を確認し、新規参入者に最初に何が必要かを特定します。その後、技術担当者に文言の確認を依頼します。

この種のレビューは、準備態勢に関するものであり、活動自体を追加するためのものではありません。人が見えるものを見ます。また、チームが正確に維持できるものも考慮します。結果として、より有用な README の冒頭、より適切に配置されたセットアップガイド、または技術的な質問へのより明確な経路が得られるかもしれません。

あなたのプロジェクトに、ツール用とサンプル用の 2 つのリポジトリがあるとします。それらの説明が、それらの関係を説明していないかもしれません。私たちはその関連性を指摘し、説明が属する場所を提案します。あなたのチームが編集を行うかどうかを決定します。技術担当者が最初に確認します。

コミュニティの質問が GitHub を超えた場所を必要とする場合、コミュニティ管理とモデレーションが会話面をサポートできます。リポジトリのガイダンスとコミュニティの導線は明確に区別し、それぞれが明確な目的を果たすようにします。

新しいコントリビューターは何を理解できるべきですか？

新しいコントリビューターは、プロジェクトを理解し、関連する指示を見つけ、適切な次のステップを踏む方法を理解できるべきです。私たちはこれらのステップを訪問者としてレビューします。そして、不足している情報と、単により適切な場所を必要とする情報を分離します。

わかりやすい説明から始める

リポジトリは、その目的と対象読者を簡単に把握できるようにする必要があります。説明と README が一貫して用語を使用していることを確認します。また、それらが最新のプロジェクト資料を指していることも確認します。製品コンテキストが不明瞭な場合は、仮定を追加する代わりに、チームに事実を尋ねます。

最初のアクションを可視化する

はじめにの手順は、誰かがプロジェクトを試す前に必要なものを示すべきです。コントリビューションガイダンスは、チームが実際にサポートできるプロセスを反映しているべきです。役立つ次のステップは、質問をする方法や変更を提案する方法を文書化することかもしれません。その経路をあなたと確認します。

引き継ぎを明確に保つ

誰かが助けを必要とする場合、どのチャンネルが監視されているかを推測する必要があってはなりません。リポジトリのガイダンスをコミュニティ活性化計画に接続しつつ、技術ドキュメントは技術詳細の参照先として維持できます。

レビュー前に、現在のセットアップ手順と各リポジトリの対象読者を集めてください。また、技術的主張を確認できる担当者を指名してください。例えば、チームは好みの製品説明とサポートチャンネルを教えてくれます。これにより、一貫性のない言葉遣いや不明瞭な引き継ぎを特定するための確かな基盤が得られます。

3 つのチェックポイントで、リンクから実用的な変更へと作業を進めます

レビューは 3 つのチェックポイントを通じて進みます。プロジェクトを理解し、公開資料を確認し、合意されたアクションを引き渡します。作業は、あなたが特定したリポジトリと対象読者に焦点を当てます。

1. 開始点を共有する。 リポジトリリンク、簡単な製品説明、資料が対象とする人々を送ってください。レビューから除外すべきプライベートまたは機密領域があれば記載してください。
2. 確認内容に合意する。 確認するリポジトリとドキュメントを確定します。また、推奨事項またはコピー支援のどちらが必要か、技術情報を確認できる担当者も確定します。
3. 訪問者の経路をレビューする。 リポジトリの説明、README コンテンツ、ドキュメントリンク、コントリビューションガイダンスを確認します。調査結果は、読者が何を必要としているか、誰が各項目に対応できるかによってグループ化されます。
4. 事実を一緒に確認する。 あなたの技術担当者が提案された文言をレビューし、どの詳細が正確かを確認します。製品の動作や実装に関する主張は、あなたのチームが検証するために残します。
5. 作業を引き渡す。 合意されたアクションリストと、含まれるコピーやドキュメント作成支援を、担当者を明確にして受け取ります。

スケジュールは、リポジトリの数と関連資料の量を確認した後に設定します。あなたの側の単一の指名担当者が、技術的な質問をスムーズに進めるのに役立ちます。あなたのプロジェクトがTelegram コミュニティ成長やDiscord コミュニティ成長も利用している場合は、それらの遷移先を共有してください。そうすれば、GitHub がどのように訪問者をそれらへ誘導しているかを確認できます。

レビュー後も公開資料の有用性を維持する

明確な GitHub プレゼンスには、レビュー後の担当者が必要です。リポジトリの詳細とドキュメントは製品とともに変化する可能性があります。私たちは、チームが絶え間ない外部サポートに依存しない、実用的な次のアクションを残せるように支援します。

合意された各変更について、1 人の担当者と更新が属する場所を指名してください。技術的な指示は、開発者が確認する必要があります。プロジェクトの説明とリンクは、それらを最新に保つことができる誰かを必要とします。簡単なチェックインで、README がまだ製品と一致しているかどうかを尋ねることができます。また、主要なリンクが機能するかどうかも確認できます。そして、コントリビューションガイダンスがチームの実際のプロセスを反映しているかどうかを確認します。

公開資料のレビューと、合意されたドキュメント作成作業をサポートできます。あなたのチームは、リポジトリへのアクセス、公開の決定、セキュリティに関わる詳細、および継続的なメンテナンスを管理します。プライベートな認証情報や機密性の高い実装情報は、公開ファイルに含めないでください。公開前に、適切な技術担当者に変更を承認してもらってください。

GitHub は、リポジトリの表示や表面化の方法を管理します。訪問者は、読むか、共有するか、コントリビュートするかを決定します。私たちは、あなたと合意したレビューと資料にコミットし、プラットフォーム上の可視性や外部からの参加にはコミットしません。

開始する準備ができたら、リポジトリリンク、簡単なプロジェクト説明、リーチしたい対象読者を送ってください。私たちはあなたと開始点をレビューし、範囲を確認し、次のステップに合意します。

仕組み

1. プロジェクトコンテキストを共有するリポジトリリンク、簡単な製品説明、リーチしたい対象読者を送ってください。プライベートにすべき情報があれば記載してください。
2. レビューの範囲に合意する確認するリポジトリとドキュメント、必要な支援の種類、技術詳細を確認できる担当者を確定します。
3. 調査結果をレビューし整理する公開体験を確認し、実用的なアクションを読者のニーズと担当者ごとに分類します。
4. 技術的な文言を確認するあなたの技術担当者が、チームが公開または使用する前に、提案された詳細を確認します。
5. 合意された作業を受け取る優先順位付けされたアクションと、含まれるコピーやドキュメント作成支援を引き渡します。