• ベストアンサー

ドキメントの手直し

最近やっていたプロジェクトのドキメント作成に関わっていたのですが、そのPGを「パッケージ化出来ないか?」といわれ、まずドキメントを手直しするようにと言われました。まずは何から手をつけていけばいいものでしょうか?今のところはまったくわからないので宜しくお願いします。

  • 3396
  • お礼率32% (29/90)

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

  • ベストアンサー
  • a-kuma
  • ベストアンサー率50% (1122/2211)
回答No.1

どういうプログラムを、どういうパッケージにするのかが良く分からないですが、 ・ソースを読まなくても、ドキュメントだけを読めば使える ・ドキュメントを読めば、実際に「もの」を動かさなくても、何をどうすれば良いか分かる というところが、基本です。 例えば、関数ライブラリみたいなものであれば、ソースを読んだり、テストプログラムを 書いていろいろ動かしてみたりしなくても、どういう条件なら正常に動作し、どういう 場合なら、どのようにエラーを返す、ということがドキュメントだけで分かる、と いうことが求められます。

関連するQ&A

  • 開発用ドキュメントのあり方

    お世話になります。 要件定義書などのドキュメントのあり方について、ふと疑問におもうことがあり、質問させていただきます。 先日、私の会社で小さなプロジェクトを行うことになり、開発に関するさまざまなドキュメントを必要としています。 そこで問題は、そのドキュメントをどういう形式で作成しようかということです。 私としては、適材適所色々あるので、エクセル、ワード、あればビジオを使い分けすべきであるとおもうのですが、エクセルで統一しましょうという意見も中にはあります。 効率のよさという点から言うと、統一したほうが楽ではありましょうが、今まで自分の見てきた要件定義書などは大概ワードで作成されていることが多く、エクセルで書くことに若干抵抗があります。 皆さんは、どのような形式でドキュメントを作成されていますか?

  • ドキュメント削除

    昨日印刷していた項目を給紙のときか、手直ししようと思ったかのタイミングでドキュメント削除をしましたがいつまでも削除中の表示が続き、新しい印刷ができないのですが、どうしたらいいでしょうか? ※OKWAVEより補足:「キヤノン製品」についての質問です。

  • 複数のドキュメントを1つのドキュメントにする

    ワードで、2枚のドキュメントを作成した後に、1枚のドキュメント(ページ2/1,2/2) としたいです。やり方があるのなら、教えて下さい。

  • ドキュメントについて

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

  • ドキュメントの書き方について

    CGIアプリケーションでWEBシステムを構築しています。 概要は「予約システム」になります。 このシステムのドキュメントを作成するに当たり どのように書いたらいいのか、悩んでいます。 皆さんはどのようなドキュメントを作成しているのでしょうか? サンプルや参考サイトなどがあれば教えていただけないでしょうか? よろしくお願いいたします。

    • ベストアンサー
    • CGI
  • autocad 2013 図面の手直しについて

    CAD超初心者練習中ですが、図面の手直し担当となりました。 複雑な配管を短くしたり、部分的に形を変えたり、などとてもてこずっており 今の段階で全くできていません。来週末から本格的にしなくてはいけないのですが とても焦っています。テキストでは2ヶ月間勉強しているのですが、全く応用がききません。 ネット上で配管などの部分的な手直しができるサイトがありましたら 教えてください。 どうぞよろしくお願いします。

  • ドキュメントが開けない

    「ドキュメント、コンピューター、最近使った項目」等からファイル(ドキュメント)が開けない(「見つかりません」と表示される)。 拡張子は合っています。 Officeボタン→「最近使ったドキュメント」からは開くことができます。

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

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

  • ドキュメントの保守について

    ソフトウェア開発で画面仕様書などのドキュメントを作成すると思います。 開発中や開発終了後、機能変更や追加が行われた場合、 既に作成されている仕様書も合わせて変更や追記される必要があると思います。 しかし、今の現場ではこのドキュメントの更新が徹底されておらず、 ドキュメントとアプリケーションの実際の仕様にギャップがあります。 機能の追加や変更があった場合に、 ドキュメントの更新を徹底させる何か良い方法はありませんでしょうか。

  • ドキュメントについて。

    すいません。初めて利用させてもらいます。 OSはVISTAを使用しております。 質問の内容は、ドキュメントの中にいくつかフォルダが あるのですが、その中には、自分で作成したものの他に フォルダがあるのですが、全然身に覚えのないものでは ないのですが、自分で作成した覚えもありません。 例として InterVideo マイ PSP ファイルなどがあります。 ドキュメント内にフォルダが勝手に作成されるのは 自然なことなんですか? ご指導下さい。 ちなみに、マイ PSP ファイルとはなんですか?