フィードバック

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

  • [アーティクル]

これは、新規作成時または既存の記事の更新時に適用するルールの概要です。 これらのルールの詳細な説明と例については、共同作成者ガイドの他の記事を参照してください。

メタデータ

  • ms.date: MM/DD/YYYY の形式で指定する必要があります
    • 重要な更新プログラムまたは事実上の更新プログラムがある日付を変更する
      • 記事を再編成する
      • 事実上のエラーの修正
      • 新しい情報の追加
    • 更新プログラムに意味がない場合は、日付を変更しない
      • 誤入力と書式設定の修正
  • title: スペースを含む43-59 文字の一意の文字列
    • サイト識別子を含めない (自動生成される)
    • 文の大文字と小文字の使用-最初の単語と適切な名詞のみを大文字にする
  • description: 115-145 文字 (スペースを含む)-この抽象は検索結果に表示されます

書式設定

  • バックティック段落内でインラインで表示される構文要素
    • コマンドレット名 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 の最大深度
  • 前と後の空白行
  • エラーでは、スキーマに特定のヘッダーが適用されます。ヘッダーを追加したり削除したりしないでください。

コード ブロック

  • 前と後の空白行
  • タグ付きコードフェンスの使用- powershell、 出力、またはその他の適切な言語 ID
  • タグなしフェンス-構文ブロックまたはその他のシェル
  • [ コピー ] ボタンを使用するためのを意図していない単純な例を除き、出力を別のコードブロックに配置します。
  • サポートされている言語の一覧を表示する

表示内容

  • 適切にインデント
  • 最初の項目の前と最後の項目の後の空白行
  • ブレット-アスタリスク () を使用し - ない ()-アスタリスク ( * ) ではなく、強調と混同するのは簡単ではありません
  • 番号付きリストの場合、すべての数値は "1" です。

用語

  • powershell と Windows PowerShell powershell の比較
  • 製品用語を見る

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

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

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

  • PowerShell 構文

    • コマンドレットとパラメーターの完全な名前を使用する-エイリアスなし
    • コマンドラインが長すぎる場合にパラメーターにスプラッティングを使用する
    • 行継続バックティックを使用しない-必要な場合にのみ使用します

  • PowerShell プロンプト () を削除または簡略化します ( PS> この例で必要な場合を除く)

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

    ### 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.

  • コードブロックの間に段落を入れないでください。 記述内容はすべて、コードブロックの前または後に記述する必要があります。

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

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