手順書、特に Oracle Database の構築手順書を書くときのポイントをまとめてみました。
前提条件を書く
参考情報を書く
- 製品マニュアル、Note、KROWN、書籍などから引用した場合は情報源を記載する。
- さらに詳しい情報を調べたいとき、どのような情報源を参照すれば良いか記載する。
実行ホストと実行ユーザがわかるように書く
- root ユーザ
[root@node01]# cd <user's home directory>
- 一般ユーザ
[oracle@node01]$ cd <user's home directory>
どのディレクトリでコマンドを実行しているかわかるように書く
[oracle@node01]$ cd /tmp [oracle@node01]$ du -hs
具体的な例を書く
- 抽象的に書きすぎるとわかりずらくなる。また、抽象的な手順は製品マニュアルなどに記載されている。
凡例を書く
2ノードRAC構築手順を書く場合。
コマンドの書式
[<ユーザ名>@<ホスト名>]$ <コマンド>
コマンドの例
- ノード1のみで実行する手順。
[oracle@node01]$ cd <ユーザのホームディレクトリ>
- ノード2のみで実行する手順。
[oracle@node02]$ cd <ユーザのホームディレクトリ>
- 両ノードで実行する手順。
[oracle@<両ノード>]$ cd <ユーザのホームディレクトリ>
