% 表題: インストール記録文章の書き方 % % 履歴: 2001/06/16 杉山耕一朗 ■はじめに epnetfan では作業報告文章を書くことを義務づけていますが, それは, ・自分のため. パソコンはよく壊る. インストールし直す必要にかられることが多々ある. ・情報の共有 ・エラーの同定(どこが間違っているのか把握する) のために必要です. 面倒くさがらずにきちんと書いて下さい. よく「うまく 動きません」という質問がなされますが, 何をどう設定したか記録しておい てくれないと, 誰も手助けできません. ■書くべき内容 誰が読んでも何をすれば良いか分かる文章を書くという観点に立って, 以下 のことを明記すれば完璧べきでしょう. (最初はしんどいでしょうね.) 0. 目次 - 長い文章になってしまった場合は必要. 1. インストールするソフトウェア名とその機能 - ダウンロードしてきたものならば, その URL を明記. - Debian パッケージならば, パッケージ名を列挙する. 2. インストールの目的 - 目的に応じてソフトウェアの設定項目が変わるので, なんでそのソフトウェアをインストールしたのか, そのソフトウェアを用いて何を行いたいのかを明記しておく. 3. インストール前の作業 - インストール前に行う作業があれば明記する. 例えば, 前もってカーネルを再構築しなくてはいけないとか. 4. インストール方法 - Debian パッケージをインストールしたならば, # apt-get install (パッケージ名) とか - 自分で make したならば, - README を読む - Makefile をどのように修正したか - どのようなコマンドを用いてインストールしたか - インストール時に聞かれた質問項目と, それに対する返答 (OS のインストール時には, キーボードの種類とか聞かれますよね) 5. 設定方法 - 設定ファイル名 - 設定した項目(設定ファイルの編集箇所) 6. ソフトウェアの使い方 7. インストールに関するノウハウ - インストール時に A すると失敗したとか. 8. 参考文献 - 本の場合は, 著者, タイトル, 発行年, 出版社, ISBN コード - Web サイトの場合は, (著者), ページのタイトル, URL ■表記に関して 表記に関する注意事項を列挙します. 1. 全角英数文字は使わないように. 半角英数で. 2. コマンド名はそのまま英数で書く. 日本語訳しなくて良いです. 3. 「→」は使わない. これを使うと前後の因果関係がぼやけてしまい, 読む人によって解釈が異なってしまいます. 4. 字下げは揃える. 字下げが揃っていないと文章の階層構造が正しく 把握できません.