PowerShell ドキュメントへの概要の投稿
この記事では、PowerShell ドキュメントの共同作成者として作業を開始する方法の概要を説明します。
PowerShell-Docs構造体
PowerShell-Docs リポジトリは、参照と概念の 2 つのコンテンツ グループに分かれています。
リファレンス コンテンツ
参照コンテンツは、PowerShell に付属するコマンドレットの PowerShell コマンドレット リファレンスです。
参照はバージョン フォルダー (5.1、7.0、7.1、7.2) で収集されます。 このコンテンツには、PowerShell に付属するモジュールに対してのみコマンドレットリファレンスが含まれています。 このコンテンツは、コマンドレットによって表示されるヘルプ情報を Get-Help 作成するためにも使用されます。
概念的コンテンツ
概念ドキュメントには、次の内容が含まれています。
- リリース ノート
- セットアップ手順
- サンプル スクリプトとハウツー記事
- DSC ドキュメント
- SDK のドキュメント
概念ドキュメントはバージョン別に整理されていません。 すべての記事は、PowerShell のすべてのバージョンに対して表示されます。 バージョン固有の記事の作成に取り組んでいます。
注意
概念記事が追加、削除、または名前変更されるたびに、TOC を更新し、プル要求に含める必要があります。
新しい記事の作成
投稿する新しいドキュメントに対して、GitHubの問題を作成する必要があります。 既存の問題を確認して、作業が重複していないことを確認します。 割り当てられた問題は.と見なされます in progress。 問題に対して共同作業を行う場合は、問題に割り当てられている担当者に問い合わせてください。
PowerShell RFC プロセスと同様に、コンテンツを記述する前に問題を作成します。 この問題により、PowerShell-Docs チームによって拒否される作業に時間と労力を無駄にしないようにします。 この問題により、コンテンツの範囲と、PowerShell ドキュメントに収まる場所についてお問い合わせください。 すべての記事は目次 (TOC) に含める必要があります。 提案された TOC の場所は、問題のディスカッションに含める必要があります。
注意
参照コンテンツの TOC は、発行システムによって自動生成されます。 TOC を更新する必要はありません。
既存の記事の更新
必要に応じて、コマンドレットリファレンス記事は、このリポジトリに保持されているすべてのバージョンの PowerShell で複製されます。 コマンドレット参照またはアーティクルに関する問題を報告するときは、問題の影響を About_ 受けるバージョンを指定する必要があります。 GitHubの問題テンプレートには、バージョンのチェックリストが含まれています。 チェックボックスを使用して、影響を受けるコンテンツのバージョンを指定します。
記事のすべてのバージョンを確認して、他のバージョンで同じ変更が必要かどうかを確認します。 ファイルの各バージョンに適切な変更を適用します。
ローカライズされたコンテンツ
PowerShell のドキュメントは英語で記述され、他の 17 の言語に翻訳されています。 英語のコンテンツは、という名前MicrosoftDocs/PowerShell-DocsのGitHub リポジトリに格納されます。 ローカライズされたコンテンツは、言語ごとに個別のリポジトリに格納されます。 リポジトリは同じベース名を使用しますが、末尾にロケール名を追加します。 たとえば、 MicrosoftDocs/PowerShell-Docs.de-de ドイツ語に翻訳されたコンテンツが含まれます。
一般に、問題と変更は英語リポジトリに送信する必要があります。 すべての翻訳は、最初に英語のコンテンツから始まります。 人間と機械翻訳の両方を使用します。
| 翻訳方法 | 言語 |
|---|---|
| 人間の翻訳 | de-DE、es-ES、fr-FR、it-IT、ja-JP、ko-KR、pt-BR、ru-RU、zh-CN、zh-TW |
| 機械翻訳 | cs-CZ、hu-HU、nl-NL、pl-PL、pt-PT、sv-Standard Edition、tr-TR |
機械翻訳によって翻訳されたコンテンツが、必ずしも正しい単語の選択と文法につながるとは限りません。 記事の技術的な詳細ではなく、任意の言語の翻訳でエラーが見つかる場合は、ローカライズされたリポジトリで問題を開きます。 翻訳が正しくないと思う理由を説明します。 ローカリゼーション チームは、これらの問題をレビューし、対応します。
次のステップ
GitHubで変更を送信する一般的な方法は 2 つあります。 どちらの方法も、中央共同作成者ガイドで説明されています。
- GitHub Web インターフェイスでは、既存のドキュメントを簡単に編集できます。
- 新しい記事の追加、複数のファイルの更新、またはその他の大きな変更には、完全なGitHubワークフローを使用します。
変更を開始する前に、PowerShell-Docs リポジトリのフォークを作成する必要があります。 変更は、PowerShell-Docs のコピー内の作業ブランチで行う必要があります。GitHubの クイック編集 方法を使用している場合は、これらの手順が自動的に処理されます。 完全なGitHub ワークフロー を使用している場合は、ローカルで作業するように設定する必要があります。
どちらのメソッドも、Pull Request (PR) の作成で終了します。 詳細とベスト プラクティスについては 、プル要求の送信 を参照してください。
フィードバック
フィードバックの送信と表示