Skip to main content

ガイド作成の流れ

Guides Banner

このページでは、ZAP-Docsへのガイド投稿の流れを詳しく解説しています。時系列で説明しているので、まずはここから始めるのがおすすめです。

ステップ1: コンテンツの提案​

まずはGitHubリポジトリで提案用のIssueを作成します。どんな変更や改善を行いたいか、詳細を教えてください。

既存のガイドや提案と重複していないか、初心者や上級者に役立つ内容だと自信を持って言えるかを必ず確認してください。既存の提案はIssuesページでチェックできます。

Hint

コンテンツやドキュメントのスタイルを理解するために、ガイドラインを事前に確認するのがおすすめです。

どんなテーマを求めてる？​

ZAP-Hostingで提供している製品やサービス、オープンソースソフトウェアに関する実用的で質の高いガイドを幅広く募集しています。アイデアが欲しい場合は、ZAP-Docsの既存ページを見て、書き方や掲載しているコンテンツの傾向を掴んでみてください。

冒頭でも触れた通り、すべてのコンテンツは著作権法に準拠したオリジナルである必要があります。AIや生成ツール、その他の知的財産の無断使用は厳禁です。ガイドは読者が何をどうすればいいか理解できるよう、ステップごとに丁寧に解説し、最終的に解決策を提供することを目指しています。

ほしいガイドリスト​

新規ガイドのアイデアとして役立つ提案をまとめたリストがあります。中には特別な報酬ボーナスが付くテーマも！こちらから手動でリストを確認できます。


注記

これはあくまで参考アイデアなので、必ずしもこれに沿う必要はありません。自由にクリエイティブな提案をしてくださいね。

提案の提出方法​

提案内容がZAP-Docsにふさわしいと確信できたら、ZAP Docs GitHubリポジトリにアクセスし、Contribution Suggestionテンプレートを使ってIssueを作成してください。テンプレートに沿って必要事項をすべて記入し、Contribution Terms（利用規約）への同意も求められます。

注意

報酬を正しく受け取るために、ZAP IDは間違いなく正確に入力してください！

提案を送信したら、3〜5日以内にGitHubのIssue上で返信します。

Hint

困ったときは？ ZAP-Hosting Discordサーバーに気軽に参加して、ZAPコミュニティやスタッフに質問してください。または、ウェブサイトのサポートチケットから「Contribution Program - Guides」と記載してお問い合わせいただければ、ZAP-Hosting貢献チームに繋ぎます。

返信では、提案内容に対するフィードバックや修正希望点をお伝えします。問題があればGitHub Issue上で直接やり取りします。

ステップ2: ガイドの執筆​

ドキュメントの追加や修正を行う際は、必ずガイドラインを守り、一貫性と高品質な仕上がりを目指してください。このセクションでは、新規コンテンツ作成や既存コンテンツの修正におけるベストプラクティスと最適なワークフローを詳しく解説します。GitHubの使い方に慣れていない方は、以下の簡単なチュートリアルを参考にしてください。

注記

GitHubリポジトリで提案が承認されていることを必ず確認してから作業を始めてください。承認されていない場合、報酬は保証できません。

準備するもの:

まずはZAP-Docsリポジトリのフォークを作成します。ZAP Docs GitHubリポジトリにアクセスし、ページ上部のForkボタンを押してください。

フォーク名は承認された提案に合わせて付け、Copy the master branch onlyにチェックを入れます。作成ボタンを押して数秒待てばフォークが完了します。

フォークができたら、次のセクションで投稿作業を進めましょう。コンテンツ作成には主に2つの方法があります。GitHubのウェブサイト上で直接編集する方法と、リポジトリをローカルにクローンしてIDEで編集する方法です。前者は初心者に優しく手軽、後者はDocusaurusのローカルプレビューができるのがメリットです。

Hint

Gitに慣れていない方や初心者は、方法1のGitHubウェブサイトでの編集をおすすめします。ブラウザだけで完結し、セットアップ不要で簡単です。

ガイド作成の方法​

最も簡単で推奨される方法はGitHubのウェブサイト上で編集することです。ここでは新規ガイドの作成と既存ガイドの編集方法を紹介します。

まずは先ほど作成したフォークにアクセスし、docsフォルダを開きます。

ドキュメントファイルはシンプルな命名規則で、最初の単語がガイドの種類（ゲーム、製品、セクションなど）、続く単語が具体的な内容を示します。現在のZAP-Docsサイトを見て、どのエリアに該当するか確認するのがおすすめです。例えばdedicated-windows.mdは専用サーバーのWindows OS向けガイドです。

編集したい既存ファイルを開くか、新規作成するかで手順が変わるので、下のタブから該当する方を選んでください。新規作成は少し準備が必要です。

例として、Rustというゲームのコマンドに関する新規ガイドを作る提案が承認されたとします。ZAP-Docsやリポジトリを確認すると、ゲームサーバーのカテゴリにRustセクションが既にあります。命名規則と既存ガイドから推測すると、新規ファイル名はrust-commands.mdが適切です。

新規ファイルを作るには、GitHubリポジトリのdocsフォルダを開き、画面右側のAdd FileからCreate new fileを選択します。

ファイル名欄にrust-commands.mdと入力してください。

備考

すべてのガイドはMarkdown形式なので、必ず.md拡張子を付けてください。

次にファイルの先頭にメタデータを追加します。簡単なのは既存のrust-plugins.mdなどからメタデータ部分をコピーし、必要に応じて書き換えることです。特にidはファイル名（拡張子なし）と完全に一致させる必要があります。

例：

---
id: rust-commands
title: "Rust: Admin Commands"
description: "Information on Admin commands for Rust from ZAP-Hosting"
sidebar_label: Admin Commands
services:
  - gameserver
---
注記

レビュー時にメタデータは必ずチェックしますが、困ったら気にせず進めて大丈夫です。

続き: コンテンツ作成​

ファイルを開いたら、提案内容に沿って本文を書き進めてください。こまめに保存やコミットをして、作業内容を失わないようにしましょう。

作業を安全に保存しよう

GitHubのエディタには自動保存機能がないので、ブラウザを閉じたりすると進捗が消えることがあります。

Markdown執筆には**StackEdit**のようなツールを使うのがおすすめ。ローカル保存やクラウド同期もでき、完成したらGitHubにコピペしてコミットできます。

編集画面上部のPreviewボタンでプレビュー表示に切り替えられます。もう一度押すと編集画面に戻ります。

Docusaurus固有の要素について

:::noteや:::tipなどのアドモニションやタブはGitHubのプレビューでは正しく表示されません。これは通常のMarkdownではないためです。ローカル環境や本番環境では正しく表示されます。

ガイドラインを守ろう

Markdownの書き方や構成、用語などはガイドラインを必ず参照してください。

編集が終わったら、**Commit changes...**ボタンを押してコミット画面を開きます。

何をしたか分かるわかりやすいコミットメッセージを入力し、必要に応じて詳細説明も書いてコミットしてください。これでフォークに変更が反映されます。次はコンテンツの提出へ進み、プルリクエストを作成しましょう。

オプション: ローカルでのビルドテスト​

最終的なプルリクエストを作成する前に、ローカルでビルドして動作確認するのがベストプラクティスです。プルリクエストの処理をスムーズにするために推奨しますが、必須ではありません。

Hint

これは必須ではありません。プルリクエスト提出時に自動でビルドが走りますが、ローカルでのデバッグやライブテストに便利です。

注記

ローカルでの編集チュートリアルに従った場合は、リポジトリのクローンは済んでいるのでこのステップはスキップできます。

準備するもの:

まずはフォークをクローンします。GitHub DesktopならAdd→Clone repositoryでフォークを選択してください。

Gitを使う場合は、新規フォルダ（例: Docs Test）を作り、フォルダ内でGit Bashを開きます。フォークのURLを控え、以下のコマンドを実行します（[your_url]はフォークのURLに置き換え）。

git clone [your_url]

これでローカルにリポジトリがクローンされます。次に必要なモジュールをインストールします。リポジトリフォルダで右クリックしてコマンドプロンプトを開くか、Git Bashを使い、以下を実行。

npm install

時間がかかりますが、完了するとnode_modulesフォルダが作成されます。エラーが出たらNode.jsが正しくインストールされているか確認してください。

最後にローカルでドキュメントサイトを起動します。

npm start

完了するとブラウザが自動で開き、3000ポートでローカル版サイトが表示されます。ここで本番と同じ見た目で動作確認ができます。

満足したら次のセクションに進み、プルリクエストを作成してください。

ステップ3: コンテンツの提出​

ガイドが完成し、ガイドラインに沿った高品質な内容だと自信がついたら、プルリクエストを作成します。フォークのZAP Docsリポジトリにアクセスし、主要ボタン下のContributeを押してプルリクエストを開きます。

変更内容の確認画面が表示されます。デフォルトで簡単なチェックリストが入っていますが、不要なら削除してOKです。

タイトルには何をしたか分かる内容を入れ、説明欄には提案のIDを#000形式で必ず記載してください。IDがわからなければ、ZAP Docs GitHubリポジトリのIssuesから探せます。

すべて入力・確認できたら、プルリクエストを作成して提出してください。

システムが構文や品質チェックを自動で行い、問題なければ数日以内にZAP-Docsチームがレビューします。

レビューで修正依頼があれば対応し、必要に応じてチーム側で修正も行います。すべて完了したら承認され、公開準備が整います。

ステップ4: ガイド公開＆報酬支払い​

プルリクエストが承認され、必要な修正が完了したら、プルリクエスト上で公開予定や報酬支払いに関する重要な情報をお知らせします。

備考

報酬は主にコンテンツの質や量、その他ZAP貢献チームの評価基準によって決まります。詳細は報酬についてをご覧ください。

ZAP-Hostingのガイドに貢献してくれてありがとう！みんなの投稿を心から感謝しています！💚

Cookie settings