2009-08-22 11 views
2

から私は(書式を変更すること自由に感じなさい、以下が含ま抽象ありますソフトウェア文書のサブブロック抽象

1. purpose 
2. simulation models used 
3. libraries, SDKs, and APIs used 
4. major components of application in terms of the  
    windowing blocks, and types of user controls and settings offered in 
    the application for simulation operation 
5. methods of controlling the input coordinates for the simulation to execute 
    and generate an output 

をしかし、今私はどのサブブロックを知らないんだ私は動作するはずですが私のアプリケーションが何をしているのか分からない人として、さらに詳しく説明するほうが役に立つと思いますか?事前に感謝の意を表してください。

答えて

1

を疑問視。ソフトウェアのユーザーは約1、2、5を気にします。開発者は興味を持っています.3が実装かUIかはわかりません。

まず、ユーザーガイドの準備を強くお勧めします。このソフトウェアで何ができるのですか?どのようにドライブしますか?あなたは、ガイドから詳細なリファレンスを分ける必要があることを分かっておく必要があるかもしれません。

内部のものは後で提供されます。

+0

お薦めいただきありがとうございます。ユーザーと開発者がなぜソフトウェアを使用しているのか、またはソフトウェアを使用しているのかということに興味があるので、両方のドキュメントに1をつけておくと思います。 – stanigator

+0

はい、意味があります。私が作っている基本的な点は、読者が文書を読んでいる時点でのニーズに焦点を当てることです。熱狂的なソフトウェアの人々は、読者が「何と理由」を知りたがっているか、実装の詳細、「方法」に落ち込むのは簡単です。 – djna

1

普通のユーザーの場合アプリケーションの目的や設定に特化してください。

開発者の場合は、使用するライブラリ、SDKおよびAPIをより重要視しています。

また、このを見てみましょうので、あなたがそこに少なくとも二つの文書を持っている

How do you approach documentation (external, not in-code documentation)?

+0

この情報を知っていれば、私は普通のユーザーと開発者の両方のために書いていますが、それぞれ別々のマニュアルを書くべきですか? – stanigator

+0

別々に書く方が良いです。 – rahul

関連する問題