4
「ドキュメント」を正確に構成するものは何ですか?
ソフトウェア製品の「ドキュメント」と言うとき、それには何が含まれ、何が含まれてはいけませんか? たとえば、最近の質問で、コメントをドキュメントと見なすかどうかを尋ねましたか? しかし、これが同様に有効な質問である他の多くの領域があります、いくつかは他のものより明白です: マニュアル(明らかに) リリースノート? チュートリアル コメント 他のもの? 線はどこに描かれますか。たとえば、「チュートリアル」がドキュメントの場合、「ビデオチュートリアル」のドキュメントですか、それとも別のものですか? 一般に、ソフトウェアの何かは、実装、テスト、および文書化されるまで「完了」しません。したがって、この質問は、「完了」したことを検討するために文書化の一部としてどのようなことを検討する必要があります。 私たちの会議での最近の顧客フィードバックからの質問は、私たちのドキュメントがより多くの「サンプル」を必要としていたことを示唆しています。 対象者:データベース、プログラミング言語、および関連ツール(前述のDBの管理クライアントなど)を使用するソフトウェア開発者