2. マニュアルの構成

2.1. マニュアル体系

WebOTXのマニュアルは、以下の分類で構成されています。

表2.1-1
マニュアル分類 目的 内容
全般 製品の概要を理解する
製品を導入する
製品概要
インストール手順
動作環境
注意制限事項
アップデート情報
開発 製品を利用し、アプリケーションを開発する チュートリアル
サンプル
リファレンス
運用 システムの環境を構築する
システムを運用する
設定手順
基本的な管理
よくある障害の解決方法
解析に必要な情報の収集方法
リファレンス コマンドや属性一覧
設計・構築・運用・開発で参照する資料等
設定一覧
APIリファレンス
コマンドリファレンス
付録 一般技術用語、WebOTX用語を理解する
旧バージョン用の資料等
全マニュアルで使用している用語の説明
(旧互換用)コマンドリファレンス

2.2. 対象読者別マニュアルインデックス

この節では、WebOTX製品に関わるプロジェクトリーダ、システム設計者、システム構築者、 システム運用者(オペレータ)、アプリケーション開発者(プログラマ)に対して推奨するマニュアルの参照項目について説明します。

表2.2-1
対象読者 マニュアル名
プロジェクトリーダ マニュアルガイド(本書)
製品構成と提供機能
注意制限事項
アップデート情報
クイックリファレンス
用語集
システム設計者 マニュアルガイド(本書)
製品構成と提供機能
注意制限事項
アップデート情報
クイックリファレンス
リファレンス集 運用管理・設定・構成編
クラスタリング
用語集
システム構築者 マニュアルガイド(本書)
製品構成と提供機能
注意制限事項
アップデート情報
クイックリファレンス
セットアップガイド
運用ガイド
メッセージ一覧
リファレンス集 運用管理・設定・構成編
クラスタリング
用語集
システム運用者 (オペレータ) マニュアルガイド(本書)
製品構成と提供機能
注意制限事項
アップデート情報
クイックリファレンス
運用ガイド
メッセージ一覧
リファレンス集 運用管理・設定・構成編
クラスタリング
用語集
アプリケーション開発者 (プログラマ) マニュアルガイド(本書)
製品構成と提供機能
注意制限事項
アップデート情報
クイックリファレンス
アプリケーション開発ガイド(概要)
アプリケーション開発ガイド(共通)
アプリケーション開発ガイド(Enterprise Service Bus)
サンプル集
運用ガイド
リファレンス集 運用管理・設定・構成編
リファレンス集 開発編(Enterprise Service Bus)
クラスタリング
用語集