CCOについて詳しく解説(configuration guide編)

CCOとは

Cisco製品に関するドキュメントのことを指します。特に一般のエンジニアがよく参考にするのはconfiguration guideだと思います。今回は、configuration guideについて解説します。

Configuration guideの探し方

一言に探し方と言っても色々な方法がありますが、筆者のパターンを紹介します。

1. 検索で 『製品名 configuration guide』と検索
2. ヒットしたものをクリックする
3. 上部見出しで対象製品のコンフィグレーションガイドであることを確認する

下記の画像では、Catalyst 9300シリーズを例に検索した場合です。

製品によってはOSのバージョン毎にコンフィグレーションガイドが用意されている場合もあるため、適切なものを選択してください。

configuration guideの構成

ドキュメントによって多少異なります。そのため、必ずこの構成であるとは言えません。
しかし、大まかに分類すると2種類に分類することができます。

1. 機能の説明・解説
2. 設定方法の説明・解説

ドキュメントに目に通す前に文書全体の構成を頭に入れてから読むことは必要な情報を素早く手に入れるためにも重要となります。

下記の場合、章のコンテンツとしてはレイヤ3に関するもの、レイヤ2に関するもの、QoSなどがあることが一目でわかります。

この中では今回は『システム管理』をクリックしたいと思います。すると、下記の目次が表示されます。

さらに、この中から今回は『システムメッセージログの設定』をクリックします。

このように、章のコンテンツが一覧として表示されます。コンフィグレーションガイドを読み解く場合には後述しますが、こうした章立てを意識しながら読み解くことができるだけで楽になります。当たり前だと思っていても実はできていなかったりするので、注意しましょう。

configuration guideの読み方

筆者の立場としては困ったときに助けてくれる詳しい人がいるわけでもないため、ガイドブックを読み解いて自分で仕様面を正確に理解する必要があります。最初はなかなか読みづらくてどこにどんな情報が書いてあるのか、そもそも書かれている用語に対する説明が無くて理解が出来ないことも良くありました。しかし、これはそもそもコンフィグレーションガイドの読み方というのを理解していなかったためだと思っています。今では昔と比べるとかなり早く必要な情報を収集することが容易になりました。また、ドキュメントに書かれていることを正確に理解することができるようになりました。

筆者の経験則として下記を抑えて読む訓練をすれば、数か月後には見違えるほどコンフィグレーションガイドを読みこなすことができるであろう、という観点で整理してみました。

• 必ず目次があるのでドキュメントの構成を把握するべし…①
• 各章について、「章のコンテンツ」を把握するべし…②
• 読み飛ばしはせずに章の上から順番に読んでいくべし…③
• 必要に応じてドキュメントを読んで理解したことをノートなどに書きだすべし…④

【理由】
① 既に述べておりますが、ドキュメント構成を頭に入れながら読むことで情報の整理が各段にしやすくなるためです。受験などでも使えるテクニックですね。

② これも先ほどと同様の理由です。

③ 前提条件や制約事項を見落とすことで手戻りが発生する可能性があるためです。章の後半の記述は、章の前半で既に説明済みの概念を理解していること前提のため、読んでも理解することができない場合がしばしばあります。初心者がコンフィグレーションガイドを読んでも全然理解することができないのは主にこれが原因である場合が多いです。その場合にはドキュメントの頭から章立てを意識しつつ読んでいくことは、遠回りのように見えて実は近道であることが多いです。

④情報量が多すぎるので不要な情報で頭がこんがらがることが多々あります。そのため、必要な情報を簡潔にまとめて紙などに書きだすことで、情報の整理を促し、ドキュメントが理解しやすくなります。

configuration guideを読めるようになると…

Ciscoと直契約の保守サポートを締結するにあたって、参考記事にも記載がある通り、公式ドキュメントを理解できることはサポートへ依頼できる前提条件となります。つまり、そもそも公式ドキュメントを読んでも理解することが出来ない人はサポートに問い合わせる資格がないのと同じです。

サポート側は、公式ドキュメントに記載されている情報と非公開情報を元に回答をするので、そもそも公式ドキュメントに記載されていることを理解できないと、何度もやり取りを往復することになり、トラブルに対して迅速に対応することができません。

また、Ciscoの各種資格はConfiguration Guideを元ネタにしている場合が多いため、そもそも日頃から読み込んでおけば資格取得のためにconfigや仕様面を暗記をするといったことを強いられることが少ないです(無いとはいっていない)。目次や章のコンテンツを意識しておくと、製品の機能の全量を把握することができるので、何か困ったときにどのあたりにどの情報が書かれているのか直ぐにわかります。地味にこうした能力は大事です。

そして、文字から機能や設定内容を理解する力が養われるため、configが覚えられない、コンセプトが理解できないといったことが減るはずです。こうしたドキュメント読解能力は実はエンジニア歴が長い人でも全然養っていない人が多いと思われます。

ドキュメントを正確に読める、つまり正確に理解して相手に伝えることができることは『本当に仕事で役に立つスキル』として重宝されると思っております(※適切に評価できる人が身近にいる場合に限る）。是非、Ciscoのコンフィグレーションガイドに限らずあらゆる技術系ドキュメントを読み解く場合には、これまで紹介したことを意識してもらえると、エンジニアスキルの平均値が上がって、巡り巡って世の中全体の仕事の生産性が上がり、少しでも社会は良くなるのでは、と思います。是非、少しでもお役に立てれば幸いです。