• ベストアンサー

ドキュメントの見栄えについて勉強する方法

日々、IT系の設計書や手順書やマニュアルなどの作成をしています。そこで見栄えのよいドキュメントの書き方の勉強をする上でお勧めの本を知りたいです。ご存知の方がいらっしゃいましたら教えていただけるとありがたいです。よろしくお願いいたします。

質問者が選んだベストアンサー

  • ベストアンサー
noname#245936
noname#245936
回答No.1

見栄えの良いDocumentですか。 私も手段を模索したことがあります。 が、私のいたった結論は、人のマニュアルを真似ることでして。 ソフトウェア手順書なら、 ・超図解シリーズ、カンタンシリーズの書籍。 ・優良メーカーマニュアル  Epsonさん、メルコさんあたりのH/Wメーカーさん。 この辺は勉強になると思います。 ちなみに、設計書のほうですが。 こちらは結構難しいですね。 UML や何や、ソフトウェアを修飾するDocumentはいくら書いても キリがありませんし、ソフトの変化に同期をとるのが難しいです。 エンドユーザが多ければ書く意味も違ってきますが、一般の 1000名以下のユーザしか存在しないソフトの場合は、あまり時間を とってもコスト的に元が取れないはずです。 高級言語で作成している場合、ソースコード自身が動きそのもの ですので、+Readme程度で概要をつかむ程度までしか残さない。 また、お客様へのファーストアプローチの部分は詳細まで説明を あえてしない概要ワークフローを3・4枚に抑える。 これが最適解のような気がします。 あとは、Wordなどで概要をこさえ、表紙、裏表紙、段落分け済みの テンプレートをデザインに強い方に加工していただき、統一感を だせばそこそこ見栄えはいいような気がします。 多すぎる文書はだれも読んでくれませんので。

capitarize
質問者

お礼

人のマニュアルを真似る 概要ワークフローに抑える(ドキュメントとソースの同期をとることが難しいため) なるほどと思いました。ありがとうございます。

関連するQ&A

  • ドキュメントについて

    SE(システムエンジニア)系の仕事に携わっている方で、ドキュメントの作成って重要だと思うのですが上手いドキュメントを作成するために、何か参考になるサイトや書籍などありますか?? ※上手いという表現は微妙ですね、分かりやすいとか綺麗という表現が 正しいのでしょうか  単にドキュメントといっても例えば設計書類やテスト項目書、仕様書、進捗管理などいろいろあると思います。 作業を行ううえで上手いドキュメント作りって非常に重要だと思うのですがドキュメント作成が苦手で困っています。 参考になる(勉強になる)サイトや書籍があれば拝見して勉強したいと思っております。 ドキュメント作りが上手い人って尊敬するし憧れます。 変な質問ですが、真剣に悩んでいます。 どうか宜しくお願い致します。

  • 見栄えの良い案内状を作りたい!!

    こんにちわ。今度友達の2次会の案内状を作ることに なりました。簡単にワードで作ろうと思いますが、 見栄えの良いものを作りたいと思っております。 ワードの新規作成で白紙を出しましたが、さてどうすれば見栄えのよいものを作れるものかと悩んでいます。例えば、全体的に花の絵を入れたりすることは できるのでしょうか? なにか良いやり方をご存知の方がいらっしゃいましたら、教えて頂ければ助かります!! よろしく御願い致します。

  • ドキュメントの書き方指南書を探しています。

    普段PGをやっています。 最近何かと詳細設計書や画面遷移図を書いてくれと頼まれることが多くなってきているのですが、自分にはあまり経験がありません。 ほとんど、プログラムができてから詳細設計書という流れなので、自分がかかわったことがないのです。 後学のためにも、ちゃんと覚えたいと思い、サイトや本を探してみたのですが、一般的なフォーマットになるものは見つかりませんでした。 ITMediaとかも見たんですが、逆に詳しすぎて、簡易的な画面遷移図・詳細設計などには向きませんでした。 どなたかドキュメントの書き方が具体的にわかるような本をご存知ないでしょうか? よろしくお願いします。

  • マニュアルの作成方法

    ホームページを作成し、Excelでマニュアルを作成しているのですが、どうしてみ見栄えが悪くなってしまいます。 どこかマニュアル作成上、参考となるホームページをご存知ないでしょうか。 よろしくお願いします。

  • マニュアルの作り方の勉強

    製品のユーザーマニュアルを監修しているのですが・・・ マニュアル作成の担当者が作る文章が、あまりにお粗末なのです!! 意味不明な勝手な造語を作ったり、 専門家が見てもわからないような文章を書いたり・・・ そこで、勉強してもらおうと思うのですが、 マニュアルの作り方が勉強できる本とかないでしょうか? Amazon等で探してみたのですが、 業務マニュアルの作り方についての本はたくさん見つかったのですが、 製品につけるユーザーマニュアルのような場合の本が見つからず・・・

  • エクセル2000の見栄えが違う?

    新しく入った職場で、前任者が作成した得意先住所録の見栄えが悪いので、新しく作りかえようとしています。 手順は、私が新しく作成したフォームに、前任者が作成したデータをコピーして完成を目指しているのですが、どうしてもわからないことがあります。 旧住所録と新住所録をみくらべると書体や設定が同じなのに、旧住所録の方がどうしても文字の大きさが小さく見えるのです。セルの書式設定を見ても同じ設定になっているのです。また、列の幅も表示は同じ(列と列の間の線をクリックするとサイズが出ますよね)なのに小さく見えます。これはどういうことでしょうか?前任者が退職しわかりません。バージョンは今もエクセル2000です。

  • プログラムドキュメント管理方法

    プログラム仕様書の電子データの管理方法についてです。 現在、ドキュメント管理はシステム化されていません。 プログラム仕様書はEXCELで作成しています。 稼働中のプログラムの仕様書は「最新バージョンホルダ」に入っています。 改善が発生すると、「最新バージョンホルダ」から「修正用ホルダ」に修正対象ドキュメントをコピーします。 修正前、修正後を作ります。 改善が完了し、プログラムが本番登録されたときに、「最新バージョンホルダ」に修正後をコピーします。 「履歴ホルダ」に修正前と修正後をコピーします。 以上の手順を全て手作業で(PCのエクスプローラを使って)行っています。 この手順ですと、うっかりミスによる齟齬が発生していてもなかなか発見できません。 良い管理手法や、参考になる管理手法が掲載されているサイトをご存知でしたら教えてください。 また、お勧めのドキュメント管理のフリーソフトをご存知でしたらご紹介をお願いします。 お忙しいところ恐れ入りますが、よろしくお願いします。

  • ドキュメントをDドライブに移動したいのですが、

    Windows vistaでドキュメントをDドライブに移動したいのですが、 うまくいきません。 Dドライブに移動する手順に従って 個人名→ドキュメント→プロパティの「場所」→移動→Dドライブ選択→ Dドライブの中に新たに作成したdocumentsフォルダを選択→OK →フォルダの移動で「はい」を選択→。 すると フォルダD:¥documents\○○○(ドキュメントファイルに 入っている一番上のファイル名)を作成できません、アクセスが拒否されました。というメッセージが出てきます。 手順に問題があるようには思えませんが、 何が原因で拒否されるのかお教え下さい。

  • ホームページ作成時のドキュメントタイプについて

    現在、Dreamweaver8を使ってホームページ作成を勉強しています。 市販のマニュアルを見ながら進めていっているのですが、 いきなり壁にぶち当たってしまいました。 新規ファイルを作成する際、ドキュメントタイプ(DTD)を 選択する項目があるのですが、種類が沢山あり、また、マニュアルにも どれを選んで良いかが書かれていないため、現在立ち止まっております・・・ 選択肢は下記の7種類です。 なし HTML 4.01 Transitional HTML 4.01 Strict XHTML 1.0 Transitional XHTML 1.0 Strict XHTML 1.1 XHTML Mobile 1.0 ※デフォルトでは、XHTML 1.0 Transitionalが選択されていました。 どんなホームページを作るかによって 選択すべきドキュメントタイプは違ってくるものだとは思いますが、 今現在は、マニュアルを見ながら勉強中の身でして、 どんなホームページを作るかは決まっておりません。 (技術を身につけた後で、作りたいホームページを決めていこうと思っておりました) 私のような状況の場合はどのドキュメントタイプを選んでおけば良いか、 どなたかご教授頂けませんでしょうか? もしも、 「どんなページを作りたいか決まってないなら答えようが無い」という場合は、 宜しければそれぞれのドキュメントタイプの特徴などを教えて頂けると 大変助かります。 それでは何卒宜しくお願い申し上げます。

  • 電磁気学の勉強方法を教えて

    仕事で電子コンパスをやる事になりコイルの設計をしなくてはならないようです。 電磁気学は、大学の時にかすかにやった覚えはあるのですが、何から勉強すればよいかわかりません。 何かお勧めの本、サイト等がありましたら教えてください。