次の方法で共有

エディターのチェックリスト

この記事には、PowerShell ドキュメントを作成または編集するためのルールの概要一覧が含まれています。 これらのルールの詳細な説明と例については、共同作成者ガイドの他の記事を参照してください。

メタデータ

  • ms.date: MM/DD/YYYY 形式である必要があります
    • 重要な更新または事実に基づく更新がある日付を変更する
      • 記事の再構成
      • 事実誤認の修正
      • 新しい情報の追加
    • 更新が重要でない場合は、日付を変更しないでください
      • 入力ミスと書式設定の修正
  • title: 長さ 43 ~ 59 文字の一意の文字列 (スペースを含む)
    • サイト識別子を含めないでください (自動生成されます)
    • 文の先頭の単語と固有名詞のみを大文字にするようにします。
  • description: スペースを含む 115 から 145 文字 - この要約は検索結果に表示されます

フォーマッティング

  • 段落内にインラインで表示される Backtick 構文要素
    • コマンドレット名 Verb-Noun
    • 変数 $counter
    • 構文の例 Verb-Noun -Parameter
    • ファイル パス C:\Program Files\PowerShell、 /usr/bin/pwsh
    • ドキュメント内でクリックされることを意図していないURL
    • プロパティまたはパラメーターの値
  • プロパティ名、パラメーター名、クラス名、モジュール名、エンティティ名、オブジェクト、または型名に太字を使用する
    • 太字は強調ではなくセマンティック マークアップに使用されます
    • 太字 - アスタリスクを使用する **
  • 斜体 - 「下線」を使用する _
    • 強調のためにのみ使用され、セマンティック マークアップには使用されません
  • 100行ごとに改行（または about_Topicsの場合は80行）
  • ハード タブなし - スペースのみを使用する
  • 行の末尾にスペースがありません
  • PowerShell のキーワードと演算子はすべて小文字にする必要があります
  • コマンドレット名とパラメーターには適切な Pascalケース を使用してください。

ヘッダー

  • 最初に H1 から始める - 記事ごとに 1 つの H1 のみ
  • ATX ヘッダーのみを使用する
  • すべてのヘッダーに先頭のみ大文字を使用する
  • レベルをスキップしないでください - H2 がない場合は H3 を使用しないでください。
  • ヘッダーの深さを H3 または H4 に制限する
  • 前後に空白行を追加する
  • ヘッダーを追加または削除しない - PlatyPS では、スキーマに特定のヘッダーが適用されます

コード ブロック

  • 前後に空白行を追加する
  • タグ付きコード フェンスを使用する - powershell、 Output、またはその他の適切な言語 ID
  • 構文ブロックにタグなしコード フェンスを使用する
  • リーダーが [コピー ] ボタンを使用しない基本的な例を除き、出力を別のコード ブロックに配置する
  • サポートされている言語の一覧を表示する

リスト

  • インデントを正しく設定する
  • 最初の項目の前と最後の項目の後に空白行を追加する
  • 箇条書きにはアスタリスク (-) ではなくハイフン (*) を使用して、強調と混同しないようにします。
  • 番号付きリスト内のすべてのアイテムに 1. を使用する

用語

  • PowerShell と Windows PowerShell を使用する
  • 製品の用語を参照してください

コマンドレットリファレンスの例

  • コマンドレット リファレンスに少なくとも 1 つの例が必要です

  • 例は、使用方法を示すために十分なコードにする必要があります

  • PowerShell 構文

    • コマンドレットとパラメーターの完全な名前を使用する - エイリアスなし
    • コマンド ラインが長すぎる場合にパラメーターにスプラッティングを使用する
    • 行継続用のバックティックは必要な場合のみ使用し、極力避けるようにしてください。

  • 例で必要な場合を除き、PowerShell プロンプト (PS>) を削除または簡略化する

  • コマンドレットリファレンスの例は、次の PlatyPS スキーマに従う必要があります

    ### Example 1 - Descriptive title

Zero or more short descriptive paragraphs explaining the context of the example followed by one or
more code blocks. Recommend at least one and no more than two.

```powershell
... one or more PowerShell code statements ...
```

```Output
Example output of the code above.
```

Zero or more optional follow up paragraphs that explain the details of the code and output.

  • コード ブロック間に段落を配置しないでください。 すべての説明コンテンツは、コード ブロックの前または後に記述する必要があります。

他のドキュメントへのリンク

  • ドキュメントセットの外部、またはコマンドレット参照と概念の間でリンクする場合
    • Microsoft Learn にリンクするときにサイト相対 URL を使用する ( https://learn.microsoft.com/en-usを削除する)
    • Microsoft プロパティの URL にロケールを含めない (URL から /en-us を削除する)
    • 外部 Web サイトに対するすべての URL は、ターゲット サイトに対して有効でない限り HTTPS を使用する必要があります
  • ドキュメントセット内でリンクする場合
    • 相対ファイルパスを使用する (../folder/file.md)
  • すべてのパスで前方スラッシュ (/) 文字が使用されます
  • 画像リンクには一意の代替テキストが必要です