スタイルガイド

Cloudflare のコンテンツを書くとき、またはレビューするときは、ドキュメントでもプロダクトダッシュボードでも、このガイドに従います。従うことで、サイト全体があたかも一人の慎重な著者が書いたように読めます。読者にもわかりやすく、翻訳もしやすくなります。

ガイドは、実際の作業の流れに沿って 5 つの段階で整理しています。変更のコントリビュート、コンテンツの計画、Cloudflare スタイルでの執筆、ページの作成、そして Cloudflare チーム向けにサイトの運用です。

コントリビュート

ここから始めます。変更を加えてマージします。

Issue を開くか pull request を作成し、レビューを経てマージします。

書くページの種類と、置く場所を決めます。

コンテンツタイプを選び、ページを構成し、情報アーキテクチャに配置します。

エンドポイント、パラメーター、リソースをドキュメント化するときの決まりに従います。

統一された文体、文法、書式でページを書きます。

ページを MDX で書き、メタデータを設定し、コンポーネントを追加します。

Cloudflare チームがサイトを運用する方法です。このセクションは Cloudflare 固有の内部プロセスです。

サイトのフレームワーク、リダイレクト、リンク、メタデータ、AI、動画の扱いを確認します。