Skip to main content

ブログガイドライン

Blogs Banner

ZAP-Hostingのブログ投稿が品質とスタイルの面で一貫性を保つために、ブログ寄稿プログラムでコンテンツを作成する際に守るべきガイドラインを用意しました。これらのガイドラインに厳密に従うことで、提案やドラフトの処理がスムーズになり、何より読者がより良く、一貫した高品質な体験をブログから得られるようになります。

ブログ寄稿ガイドラインは主に以下のセクションに分かれています：

  • 構成
  • スタイル
  • フォーマット
  • 用語

構成​

寄稿プログラムのブログ投稿は、読者の興味を引きつけ、情報やニュースを提供するために比較的一貫した構成に従うべきです。ZAP寄稿チームは、ブログ提案を作成する際に構成が適切かどうかを一緒に確認します。

  • ページタイトル (H1)
  • イントロダクション (H2)
  • 準備 (H2)
  • メイントピック (H2)
  • 任意：サブトピック1 (H3)
  • 任意：サブトピック2 (H3)
  • ...
  • 任意：別のトピック (H2)
  • 結論 (H2)
サブ見出しの使い方（H3 & H4）

H2のメインセクション内でH3見出しを使い、より大きなコンテンツを整理されたセクションに分けることを推奨します。上記のメイントピックセクションがその例です。

サブ見出しを使う場合、親見出し内に2つ以上のサブ見出しがあるのが一般的で、1つだけだと意味が薄くなります。

備考

上記はあくまで大まかな目安です。ブログ本文は内容に応じて異なる見出し構成でも問題ありませんが、すべてのブログ投稿はタイトル、イントロダクション、結論を含む構成であるべきです。

タイトル​

ブログ投稿のタイトルは短く、明確でキャッチーにして読者の目を引くようにしましょう。投稿内容がニュースなのか、ヒントやアドバイスなのかをはっきり示すべきです。良いタイトルの例は：Top 10 FiveM Police Scripts。

イントロダクション​

イントロは短く要点を押さえ、通常1〜2文程度にまとめます。内容としては、扱うトピックを簡潔に説明し、何を読者に提供するのか、最終的なゴールを伝えます。

SteamCMDに関するブログの理想的なイントロ例：

  • 1文目：SteamCMDは、PalworldやEnshroudedなど多くのゲームの専用サーバーをインストールするために必要な必須ツールです。
  • 2文目：この記事では、LinuxサーバーにSteamCMDを初めてセットアップする手順を解説します。例ではUbuntuを使いますが、他のディストリビューションでもほぼ同様の手順です。

このように、関連トピックを簡潔にまとめ、読者に全体の目的を示しています。

準備​

準備セクションでは、ブログの内容を実行する前に読者が満たすべき前提条件を明確にします。ソフトウェアやハードウェアの要件、ファイアウォールの設定方法、SSHやRDPでのサーバーログイン方法などが該当します。

ZAP-Docsサイトで関連ガイドを探し、準備段階で必要な手順があればリンクを貼って読者に案内しましょう。例えばSSH初期アクセスのガイドがあれば、必ずリンクして読者に先に進むよう促します。

よくある前提条件例：

  • 必要なソフトウェア（Git、Node.js、Python、Dockerなど）
  • 基本知識を得るためのチュートリアル（他のZAP-Docsページなど）
  • APIなどのユーザーアカウント
  • 必要な設定（DNS/SSLなど）

リバースプロキシのブログ例：

リバースプロキシをセットアップするには、Linuxサーバーが必要で、接続できる状態である必要があります。接続方法がわからない場合は[SSH初期アクセス](vserver-linux-ssh.md)ガイドを参照してください。また、所有しているドメインへのアクセスも必要です。使用予定のサブドメインごとに、LinuxサーバーのIPアドレスを指す`A` DNSレコードを作成してください。

メイントピック​

ここからブログのメイン部分を書きます。読者が飽きずに読み進められるよう、いくつかのセクションに分けるのがおすすめです。分割方法に厳密なルールはありませんが、大量の情報は複数の見出しに分けるのが基本です。ZAP寄稿チームがサポートします。

手順やチュートリアル形式の場合は、ステップ番号と簡単な説明を見出しに入れるとわかりやすいです（例：Step 1 - フォルダ作成）。各ステップの最初の文で読者が何をするのかを簡潔に説明し、ステップ間には簡単な導入文やまとめ文を入れて、読者に今までの進捗と次の内容を伝えましょう。繰り返しを避け、表現を変えるのもポイントです。

結論​

最後に結論セクションでブログを締めます。1〜3文で、読者が何を達成したか、何を学んだかを説明しましょう。

さらに、関連する他のブログやガイドへのリンクを貼って、読者がさらに知識を深められるように案内するのも良いです。ZAP-Docsの既存ガイドやブログがあれば必ずリンクしてください。

スタイル​

ZAP-Hostingのドキュメントは、高品質で実用的、かつ誰でもアクセスしやすいブログ投稿を目指しています。幅広いトピックをカバーし、初心者から上級者までサポートするスタイルです。

技術的かつ正確に​

ブログ投稿はできるだけ技術的に正確で最新の業界情報に基づく内容であるべきです。新しいトピックや技術に関する高品質な情報や、読者が新知識を得られるチュートリアルを提供してください。手順形式の場合は、各ステップに明確な目的と説明を入れ、必要に応じてオプションやフラグも紹介しましょう。

投稿前には必ず校正と動作確認を行い、技術的に正しいか検証してください。ZAP寄稿チームも内容をチェックし、誤りがあれば改善提案をします。

Hint

投稿前にスペルチェックツールを使うことを強くおすすめします。おすすめサイト：https://languagetool.org/

実用的で役立つ内容に​

読者がブログを読み終えた時に、何かを学び、作り上げ、設定できるようにしましょう。初心者から上級者まで対応できるよう、トピックを徹底的に掘り下げ、必要な前提条件も含めて詳細に説明してください。外部リンクはZAP-Docsにない情報や、記事に必須ではないが技術知識を深めるために役立つ場合のみ使い、競合他社のドキュメントへはリンクしないでください。

フレンドリーでフォーマルかつ包括的に​

ドキュメントは誰にでも親しみやすく、かつフォーマルなトーンを保つことを目指しています。ブログ全体を通して、経験や言語の壁に関係なく受け入れられる文体にしてください。

読者を主体にした二人称（例：「あなたは〜する必要があります」）を使い、筆者の一人称（例：「私は〜と思います」）は避けて、読者の関心を引き続けましょう。

また、年齢、人種、性別、経験、国籍、宗教、政治的立場、性的指向、社会経済的地位、技術選択に関わらず誰でも安心して読める内容にしてください。差別的・攻撃的な表現は厳禁です。

フォーマット​

当ブログはMarkdown記法でフォーマットされています。以下のセクションで使い方を理解し、ブログ投稿に活かしてください。

どんな執筆ツールでも構いませんが、Markdownの機能をフル活用できる**StackEdit**の使用を強くおすすめします。Googleドライブやファイル共有アプリに直接エクスポートして、共有リンクを送ることもできます。

Hint

Markdownの詳しい使い方はMarkdown Guideを参照してください。

見出し​

見出しはブログを論理的に分ける重要なフォーマットです。メインタイトルはH1です。

ブログではH2をメインセクションに使い、H3でサブセクションに分けます。例えば複数の手順に分ける場合などです。H4もありますが、あまり使いません。

備考

サブ見出し（例：H2の下のH3）を使う場合は、同じレベルの見出しを2つ以上設けてください。1つだけだと誤用です。

見出しの例：

## インストール
H2 - メインセクション

### ゲームファイルのダウンロード
H3 - H2のサブセクション

#### SteamCMD経由
H4 - H3のサブセクション

#### GitHubから手動で
H4 - H3のサブセクション

### 設定の準備
H3 - H2のサブセクション

### サーバー起動
H3 - H2のサブセクション

インラインMarkdown​

読みやすさ向上のため、様々なインラインフォーマットを使います。

太字​

重要な情報を強調するために使います。例：

  • ステップ間の文脈切り替え
  • ホスト名、認証情報、ユーザー名
  • 重要用語

**hello there** → hello there

イタリック​

新しい技術用語の紹介に使います。例：今日はリバースプロキシを設定します。

*ZAP-Hosting - More POWER!* → ZAP-Hosting - More POWER!

インラインコード​

技術的な情報（URL、ファイルパス、コマンドなど）に使います。

例：

  • ファイル名・パス：C:/User/[YourName]/AppData....test.png
  • URL：https://zap-hosting.com
  • ポート：:30120
  • コマンド：ipconfig
  • SQLクエリ：SELECT * FROM servers
  • キーバインド：ENTERやCTRL + C

テーブル​

繰り返し情報を整理するのに便利です。例：

| コマンド    | 説明                   | 使い方                |
| ----------- | ---------------------- | --------------------- |
| /help       | ヘルプコマンドを送信   | /help [category]      |
| /stop       | サーバーを停止         | /stop [true/false]    |

コードブロック​

コマンドやスクリプト、ターミナル出力などを示すのに便利です。

コードブロックは ``` で囲み、言語指定も可能です。例：JavaScript

function hello(name) {
    console.log(name)
}

var server = "ZAP-Hosting"
hello(server)

スクリーンショット​

手順を視覚的に案内するのに超おすすめです。

画像を追加するには以下のようにURLを指定します：

![](your_url)

Imgurなどのオンライン画像ホスティングサービスを使うのがベストプラクティスです。

用語​

ブログ投稿では多くの専門用語が使われます。すべての投稿で一貫性を保つため、米国英語のスペルを使うことを推奨します。ここではよく使われる用語の標準化を行います。

ZAP-Hosting製品​

ZAP-Hosting製品を言及する際は、正しい名称、スペル、大文字小文字を必ず守ってください。製品名はZAP-Hosting公式サイトで確認できます。

ユーザー定義属性​

ユーザー名、ホスト名、ドメイン、IPアドレス、URLなど、読者が自分の情報に置き換える必要がある部分は、[your_attribute]の形式で表記してください。[attribute]は属性名に置き換えます。

例：IPアドレスなら[your_server_ip]、URLならhttp://[your_server_ip]:30120。

初出時にどの属性を変更すべきか説明を入れて、読者が混乱しないようにしましょう。

ホスト名、ユーザー名、データベース名のデフォルトはzaphostingを使います。

ソフトウェア​

ソフトウェア名は正しいスペルと大文字小文字を守ってください。公式サイトの表記に従い、記事内では一貫性を保ちましょう。

ソフトウェアを初めて紹介する際は、公式サイトへのリンクを貼ってください。

Cookie settings