Dev Center の記事の記述

この記事の英語版に更新があります。ご覧の翻訳には含まれていない変更点があるかもしれません。

最終更新日 2022年02月15日(火)

Heroku のチームメンバーおよびアドオンプロバイダーは、Dev Center の記事を記述し、維持管理しています。このガイドでは、Heroku Dev Center の記事の記述プロセスを概要レベルで説明します。

Dev Center 以外のコントリビューターも、独自のドキュメントプロジェクトの規約を確立するための参考として、この記事を使用できます。

手順 1: 記事の目的を選択する

実際のユースケースのためのコンテンツを作成します。記事が明確な目的を持つようにします。

対象読者とその状況および動機、期待される結果について検討します。この目的を一文で表現すると、助けになります。たとえば、「Connecting to a Private or Shield Heroku Postgres Database from an External Resource​」(外部リソースから Private または Shield Heroku Postgres データベースに接続する) の目的は、次のようになります。

開発者として、Heroku Postgres に外部から接続して、Heroku 以外のアプリがデータを使用できるようにする。

Dev Center を検索して自分のトピックに関連する記事がないか探します。この検索により、記事に含める範囲を絞り込み、自分の記事で埋めるコンテンツのギャップを示すのに役立ちます。

手順 3: 概要を作成する

多くの執筆者は、下書きを書く前に概要を作成することが助けになることを知っています。主な見出しと箇条書きのメモで記事を構成してから始めることができます。

手順 4: 記事の下書きを作成する

一貫性のある読書体験をユーザーに提供するために、以下の記述ガイドラインに従います。

手順 5: コンテンツの正確さを確認する

各分野の専門家にコンテンツの正確さをレビューしてもらい、承認を得ます。

手順と例を確認する

すべての手順を実行して、正確であることを確かめる責任があります。可能であれば常に、新しい開発環境を使用してその確認を行ってください。

手順 6: 記事を編集して公開する

Heroku のチームメンバーは Dev Center チームに記事をレビューするよう通知することができます。この編集に関するレビューが公開前の最終段階となります。この最終レビューの前に、各分野の専門家が必ず記事を承認するようにしてください。Dev Center の編集担当者は発行前に記述ガイドラインに従うよう、必要な編集を行います。

アドオンプロバイダーはアドオンパートナーポータル​の提出プロセスに従い、自分の著作物を編集し、承認を受け、公開することができます。