技術記事や手順書での括弧で記載する際の慣習

はじめに

技術記事や環境構築手順書を書く際、任意の値やオプションをどう表現すれば良いか迷ったことはありませんか？
完全に標準化された書き方は存在しないものの、多くのドキュメントで利用される慣習があります。本記事では、その主要な記法を備忘のために残しておきます。

目次

1. 角括弧[]
2. 山括弧<>
3. 波括弧{}

角括弧[]

使用例

ls [オプション] 

角括弧はオプションの項目など、任意の項目を示す際に用いる。

山括弧<>

使用例

mkdir <ディレクトリ名>

山括弧は必須の項目を示す際に用いる。

波括弧{}

使用例

ping {IPアドレス|ドメイン名}

波括弧は集合、選択肢を示す際に用いる。
列挙する際はパイプを用いる。