マニュアルの作成方法 〜開発編〜 | ミニミニ管理者(システム管理者/社内SE/CIO)の独り言

[ ミニミニ管理者の独り言社員教育 > マニュアルの作成方法 〜開発編〜 ]
スポンサードリンク

マニュアルの作成方法 〜開発編〜

今回は、マニュアル作成の「企画」「設計」「開発」「テスト」の工程の内の「開発」について取り上げたいと思います。

今回のテーマである「開発」とは、いわゆる「執筆」のことで、設計に基づいて文章化することになる。実際のシステム開発と同様で、企画、設計を担当するのは業務上の上級者(SE)が担当して、開発、テストを担うのは上級者の監督下(PG)にあるものとなる。

この時に重要となるのは、統一したフォーマットで開発(執筆)する事である。

統一したフォーマットの例として挙げると。
 1)段落のつけ方
 2)漢字の用い方(「ため」、「為」を混在しないなど)
 3)画像の大きさ
 4)目次や索引といった文書構成
 5)文書NO(すべてのマニュアルで統一できる番号)
 6)フォントの種類と見出しごとのサイズ定義
 7)文末表現(ですます調、である調、体言止め)の用い方
などを統一する事である。
こうする事で複数人でマニュアル作成に取り掛かった場合でも統一感のある、読みやすい文章を心がけることができる。


◆効果的なマニュアル作成 バックナンバー◆
 マニュアルの作成方法 〜マニュアルの目的は?〜
 マニュアルの作成方法 〜企画編〜
 マニュアルの作成方法 〜設計編〜
 マニュアルの作成方法 〜開発編〜
 マニュアルの作成方法 〜テスト編〜
 マニュアルの作成方法 〜定着化編〜
 マニュアルの作成方法 〜テキストの工夫編〜


               最新記事へ     トップページ



スポンサードリンク


■Blog Ranking■
1. ←←サーバー構築・運用ブログあり お奨め:★★★★★
2. (ブログランキング ドット ネット)
3.にほんブログ村 IT技術ブログへにほんブログ村
4.BS blog Ranking
ブログランキングに挑戦中です。あなたもブログランキングに挑戦してみよう!
サーバー構築・運用ブログなんかもありますのでシステム管理者の方にもお奨めのサイトがあり!
ソニーストア
ボーズ・インイヤーヘッドホン
| 2007年05月10日 | 社員教育 | comments(0) | trackbacks(0) |

コメント
コメント投稿フォーム:
 上の情報を次回も利用する

トラックバック
トラックバックURL:
※ クリックで選択できます。
トラックバック一覧: