« 06.26 ださーい | ココ | 06.29 変わり身の術で形勢逆転? »
2007年6月28日
マニュアルなんて
マニュアルの書き方って難しい。
年中マニュアル書いてるわけではないので、いまいちこのマニュアルというものの書き方が掴めない。文体は何とか分かってきたけど、適切な表現というか、妥当な詳しさが…。
- 利用者用マニュアル
- 管理者用マニュアル
- 技術文書
利用者向けと管理者向け、というのは区別がはっきりしやすいから書く内容も大体は区別できるし、実際書きやすい。意外と利用者向けでも、初心者と初級者でどう～ってのはあるかもしれないけど、そこは初心者に合わせるってことになるやろうし。
難しいと思うのは管理者向けと技術者向けってどこで分けるのか。この辺表裏一体というか、どこまで書けばええねん、ってことになると思うんですよ。
で、揉めたのが「ユーザーIDを載せたファイルの中身をマニュアルに書く必要があるか」。
ユーザーIDとパスワードの削除をするにはviでするんやけど、削除をするための操作(ddで1行を消す)はちゃんと書いてあって、ファイルの中身が「1行に1IDと1パスワード」という形で構成されていることも書いてある。その上で、なぜファイルの中身を載せる必要があるのか、理解ができない。
Linuxの解説本みたいな技術書なら、/etc/passwdの中身の解説みたいに解説があってもいいと思うけど、そんなハックをする人のためのマニュアルではないし、マニュアル上で知る必要がある情報か、と言いたい。実際開く操作が書いてあるんやから開けばエエやん、と思う。
By ただ at 19:37 カテゴリー ; mein Erbe
« 06.26 ださーい |
06月の記事
| 06.29 変わり身の術で形勢逆転? »
トラックバック
このエントリーのトラックバックURL:
http://pinmarch.sakura.ne.jp/mt/mt-tb.cgi/1002
