PowerShell ドキュメントへの投稿
PowerShell のサポートにご協力いただき、ありがとうございます。
共同作成者ガイドは、Microsoft でドキュメントを作成するために使用するツールとプロセスについて説明する記事のコレクションです。 これらのガイドの中には、 に公開されているドキュメント セットに共通する情報が含まれています docs.microsoft.com。 ガイドの一部は、PowerShell のドキュメントを記述する方法に特有のものです。
一般的な記事については、一元管理された共同作成者ガイドで確認できます。 PowerShell 固有のガイドは、ここで参照できます。
作成協力の方法
投稿するには、次の 2 つの方法があります。 どちらの方法も、Microsoft にとって価値があります。
イシューの報告により、Microsoft は弊社のドキュメントの問題や矛盾点を特定することができます。 場合によっては、イシューは解決が難しく、調査がさらに必要になることがあります。 イシューのプロセスにより、私たちは問題について会話し、十分な解決策を策定することができます。
コンテンツを追加pull request 変更する必要がある場合は、より複雑なプロセスです。 次の情報では、ドキュメントにコンテンツを送信するためのツール、プロセス、基準について説明します。
投稿するための準備
ドキュメントの共同作成には、GitHub アカウントが必要です。 次のチェックリストを使用して、投稿に必要なツールをインストールして構成します。
- GitHub にサインアップします
- Git ツールと Markdown ツールをインストールします
- Docs Authoring パックをインストールします
- Posh-Git をインストールします (推奨されますが、必須ではありません)
- ローカル Git リポジトリを設定します
- Git と GitHub の基礎を確認します
ドキュメントの作成を開始する
ドキュメントに変更を加えるには、次の 2 つの方法があります。
- 既存のドキュメントへのクイック編集
- 軽微な修正、誤字の修正、または小さな追加
- ドキュメント用の完全な GitHub ワークフロー
- 大きな変更、複数のバージョン、画像の追加または変更、または新しい記事の投稿
また、一元化された共同作成者ガイドの「書き込みの要点」も参照してください。 もう 1 つの優れたリソースは、Microsoft ライティング スタイル ガイドです。 Microsoft ライティング スタイル ガイドの目的は、エディター、テクニカル ライター、開発者、マーケティング担当者など IT に関するすべての人の記述するコンテンツを向上させることです。
パブリック リポジトリに含まれているドキュメントとコード例に対する軽微な修正や明確化は、docs.microsoft.com の使用条件の対象になります。
重要な変更を行う場合は、完全な GitHub ワークフローを使用します。 Microsoft の従業員でない場合は、重要な変更によって、オンラインの Contribution Licensing Agreement (CLA) を送信するように求めるコメントがプル要求に生成されます。 プル要求が正しく確認され受理されるように、オンライン フォームへのご記入をお願いいたします。
倫理規定
docs.microsoft.com に公開されるすべてのリポジトリには、「Microsoft オープン ソース倫理規定」または「.NET Foundation 倫理規定」が適用されます。 詳細については、倫理規定に関する FAQ を参照してください。
次のステップ
次の記事では、PowerShell ドキュメントに固有の情報を紹介します。 一元化された共同作成者ガイドのガイダンスと重複している箇所については、それらの規則が PowerShell コンテンツの場合ではどのように異なるかについて示しています。
以下のドキュメントを確認してください。
その他のリソース
フィードバック
フィードバックの送信と表示