自作ソフトウェアのドキュメントを書こうと思っています。わかりやすいドキュメントを書く際に気をつけるべきこととしてはどんな物があるでしょうか?

回答の条件
  • 1人5回まで
  • 200 ptで終了
  • 登録:2006/07/04 19:52:10
  • 終了:2006/07/11 20:15:17

回答(11件)

ただいまのポイント : ポイント13 pt / 200 pt ツリー表示 | 新着順
本当にいいソフトとは nandedarou2006/07/08 05:35:20ポイント1pt
本当にいいソフトとは マニュアルがなくても使い方がわかるソフトだと思います。 ※質問の趣旨から外れてごめんなさい。m(__)m
ドキュメントとは m-nisi2006/07/04 22:55:20ポイント3pt
利用者向けのドキュメントですか? それとも開発者向けのドキュメントですか? それによって違ってくると思いますが、 利用者向けのドキュメントなら他の人が書いてある事でいいと思います。 開発者向けのドキュメ ...
ターゲットはどこか? paihu2006/07/08 05:04:26ポイント1pt
利用者向けか,開発者向けか という違いもありますが利用者向けと考えるとして,素人から玄人までいるので,どのあたりに焦点を当てるかだと思います. ほかの人も書いてますが,更新履歴を気にするレベルの人もい ...
想定する読み手次第というのに同感 gakuyo2006/07/06 00:09:04ポイント1pt
想定する読み手次第というのに同感です。 私が本を書く際にも、とにかく、これを間違うとどうしようもなくなります。もちろん、あらゆる読者に合わせることはできないので、想定外の方については「ゴメンナサイ」す ...
使い方が感覚的に理解できる具体例 nandedarou2006/07/06 05:39:03ポイント1pt
機能の網羅的な説明の他に、 ソフトの使い方が短時間で感覚的に理解できるように 具体例を用いての説明が欲しい。 こういうのチュートリアルっていいますよね? でも、チュートリアルって言葉自体があまりなじみが ...
設計書が必要では nagi00082006/07/05 09:56:26ポイント1pt
私は今までサーバの構築~運用を行っていたので、 ソフトウェアのドキュメントとは若干違うのですが、 共通点があればと思います。 まず、重要なのはどのような物を作るにしろ、 設計書が必要かと思われます。 < ...
画面イメージ viba2006/07/04 23:10:03ポイント1pt
やっぱりどんなドキュメントでも多くの画面イメージを 用い説明をしたほうがわかりやすいですよね 特に不特定多数に配布する場合、くだらない質問が来ても 困るので、それを防ぐためにも極力シロートに わかりやす ...
表示されるメッセージの一覧 shige_atenza2006/07/04 22:34:52ポイント1pt
エラーメッセージやワーニングメッセージが出ると思います。 それぞれの意味と、どう対応すればいいのかの対応表があれば いいかなって思います。
索引が必要 kurukuru-neko2006/07/04 20:37:52ポイント1pt
どこに何がかいてあるかの大まかな索引が あれば便利
更新の履歴が気になります takaramonob2006/07/04 20:17:15ポイント1pt
長い間使用できるソフトを利用したいので、過去のバグや不具合修正の経緯が細かく明記してあるソフトは、その後も安心できそうな気がするので使ってみたいと思います。
readmeのテンプレートを見る yamiwolf2006/07/04 20:04:18ポイント1pt
動作確認環境、必要ランタイム、作者名、連絡先、簡単な使い方の説明は必ず必要でしょう そうしなければ、利用者にドキュメントを読んでもらった場合、よくわからないと言ったことがよくあります。 また、ドキュメ ...

コメントはまだありません

この質問への反応(ブックマークコメント)

「あの人に答えてほしい」「この質問はあの人が答えられそう」というときに、回答リクエストを送ってみてましょう。

これ以上回答リクエストを送信することはできません。制限について

絞り込み :
はてなココの「ともだち」を表示します。
回答リクエストを送信したユーザーはいません