kkamegawa's weblog

Visual Studio,TFS,ALM,VSTS,DevOps関係のことについていろいろと書いていきます。Google Analyticsで解析を行っています

書きたくないマニュアル

お仕事で作ったプログラム。そりゃマニュアルは書かなくてはならない。今ではオンラインヘルプも多いけれど、業務用アプリケーションだと紙で印刷できるようなものがなくてはならない場合が多い。
今日も休日出勤してCitrix Presentation Server使ったソフトの説明書いていたんだけど…よくよく見なおしてみると、自分のプログラムにかかわるところだからどうしても書かなきゃいけないところは130ページ中、30ページもあるかどうか。残りはぜーんぶTerminal ServiceやPresentation Serverのインストールハウツー。書き終わって、私何書いたんだろうと結構悲しくなった今日の午後。この辺をほとんど全部削除できれば薄く、読みやすくなると思うんだけど。
でもこの辺書かないとわからないって言われるんだよなぁ。Presentation Serverも少ないとはいえ、本が転がっているし、PDFのドキュメントも割と親切(でも読まない)。んで、私も書くんだけど、市販書籍っぽく書くから評判が良くないらしい。現場で運用する人はそれこそ「こうキーをたたきなさい」というくらいまで落としこまないと嫌がるんだそうだ。
データセンタみたいなところのオペレータさんに渡すものなら確かにそういう形式の指示書は必要だと思うんだけれど、マニュアルとは別だと思うんだ。
ちなみにマニュアルそのものや方式を説明するドキュメント書くのは結構好きです。

Citrix Presentation Server 運用管理ガイド

Citrix Presentation Server 運用管理ガイド