- ベストアンサー
ドキュメントの書き方について
- みんなの回答 （2）
- 専門家の回答
質問者が選んだベストアンサー
内部仕様書と外部仕様書が有ると思います。 内部仕様書は、 RDBを使っているのなら、各テーブル間の関係は、ER図が良いと思います。 CGIのモジュール一覧表を作ると後で、直す箇所が分かります。 関数一覧表も後々便利です。 モジュール遷移図を作り、画面パラメータを書いて置くと、便利です。 各CGI毎の細かい処理は、PAD図で記述するのが良いと思いますが、 時間がもったいないので、止めましょう。 それより、ソースに処理内容をコメントととして、たくさん書いたほうが実用的です。 外部仕様書は、 運用部署に入出力データと処理の関連を理解してもらうためには、業務フロー図が良いと思います。 http://itpro.nikkeibp.co.jp/article/COLUMN/20080619/308731/ 操作説明書は、各画面毎に作れば良いと思います。 A3用紙に各画面を矢印で並べて繋げて、画面遷移図を作ると良いです。
その他の回答 (1)
- Taiyonoshizuku
- ベストアンサー率37% (183/489)
ドキュメントって、設計書？説明書？
補足
Taiyonoshizuku さん、 設計書、「プログラム設計書」になります。 よろしくお願いします。
関連するQ&A
- ドキュメントについて
ＳＥ（システムエンジニア）系の仕事に携わっている方で、ドキュメントの作成って重要だと思うのですが上手いドキュメントを作成するために、何か参考になるサイトや書籍などありますか？？ ※上手いという表現は微妙ですね、分かりやすいとか綺麗という表現が 正しいのでしょうか 単にドキュメントといっても例えば設計書類やテスト項目書、仕様書、進捗管理などいろいろあると思います。 作業を行ううえで上手いドキュメント作りって非常に重要だと思うのですがドキュメント作成が苦手で困っています。 参考になる（勉強になる）サイトや書籍があれば拝見して勉強したいと思っております。 ドキュメント作りが上手い人って尊敬するし憧れます。 変な質問ですが、真剣に悩んでいます。 どうか宜しくお願い致します。
- ベストアンサー
- その他([技術者向] コンピューター)
- システム開発ドキュメントのサンプルフォーム
自社で使う業務アプリケーションをベンダーと共に開発しています。 社内でシステム開発に関するドキュメントの標準化を進めて行こうと考えており まず各ドキュメント（設計書やテスト計画書など）の標準フォーマットを作って行きたいと 考えております。そこで標準的なサンプルフォーム（Word、Excel）がないかと サイトを検索しましたが、なかなかそのようなサンプルフォームを提供しているサイトがありません。 もしご存知でしたら教えて頂けないでしょうか。宜しくお願いします。
- ベストアンサー
- その他([技術者向] コンピューター)
- 仕様書のサンプルってありませんか？
こんにちわ。 私は今、社内でRDBMS+PHP＋Flashを使用したシステムを 構築しています。 部内用なので3人で作っています。 期限も短かったのでなにもドキュメントなしに作り始め ました（これが問題なのはよくわかっています・・・） で、本来なら逆なのですがこれからドキュメントを整備 していこうと思っています。しかし、私自身各種仕様書 というものを作ったことがありません。 また、会社自体コンピュータ関係ではありますが開発会社 ではないため社内にサンプルも見つけられず困っています。 そこで仕様書について書き方やサンプルなどが掲載されて いる本やサイトがあれば教えてください。 自分で探した限りではいいものが見つかりませんでした。 当然社外秘でしょうし、書き方に決まりはないのでしょう からサンプルでかまいません・・・。 また、こうしたwebを使用したシステムの場合の仕様書 はどこまで書くのでしょうか？（JAVAScriptとかは？）
- ベストアンサー
- その他（プログラミング・開発）
- こんなシステムがあったらいいな！！
レストランをWebで予約する場合、 こういうシステムがあったら便利だなとかこういうのがあったらもっとよくなると、いうのがあれば教えていただきたいです。 レストランシステム構築を勉強でしてみようと思っていまして、是非参考にして組み込んでみたいです。
- 締切済み
- PHP
- Office2003ドキュメントの脆弱性について
社内でOffice2003で作成したExcel等のドキュメントについて そのままの形式で保存しているとOffice2003を使わなくても 危険があるとの声を聞きました。 脆弱性はアプリケーションにあり、サポートの終了したアプリケーションで 作成されたファイルかどうかは関係無いと考えているのですが、 やはり、危険なのでしょうか。 皆が納得できる根拠があればご教授いただきたく。
- ベストアンサー
- SE・インフラ・Webエンジニア
- WebサイトのAPIドキュメント作成について
VisualStdio2010で作成しているWebサイト（C#）のAPIドキュメントを作成しようとしています。 こちらのサイト http://handcraft.blogsite.org/ComponentGeek/ShowArticle/65.aspx を参考に、実施していたのですが、 「3. APIドキュメント作成用のアセンブリとXmlファイルの作成」の最下行にある通り、 Sandcastle Help File Builderのヘルプから [Getting Started]-[Documenting Web Projects]の 「Documenting Website and Web Service Website Projects」 に書いてある通り、 web.configに -------------------------------------------------------- <system.codedom> <compilers> <compiler language="c#;cs;csharp" extension=".cs" compilerOptions="/docpath:C:\Publish\Docs" type="EWSoftware.CodeDom.CSharpCodeProviderWithDocs, EWSoftware.CodeDom, Version=1.1.0.0, Culture=neutral, PublicKeyToken=d633d7d5b41cbb65"> <providerOption name="CompilerVersion" value="v4.0"/> </compiler> </compilers> </system.codedom> -------------------------------------------------------- を追加してみたのですが、 --------------------------------------------------------- エラー 1 CodeDom プロバイダー型 "EWSoftware.CodeDom.CSharpCodeProviderWithDocs, EWSoftware.CodeDom, Version=1.1.0.0, Culture=neutral, PublicKeyToken=d633d7d5b41cbb65" を読み込めませんでした。 ----------------------------------------------------------------------- とエラーが出力されました。 ヘルプでは、.net3.5を対象にしており、visual studio2010 で.net4.0を使用していることから、 バージョン違いによる誤りがあるのだと思っていますが、対応方法がわかりません。 対応方法についてご存知の方がいらっしゃいましたら教えてください。 また、このほかにVisualStdio2010で作成しているWebサイト（C#）のAPIドキュメントの作成方法をご存知でしたら、そちらを教えていただけると助かります。 以上、よろしくお願いいたします。
- 締切済み
- Microsoft ASP
- ドキュメントの保守について
ソフトウェア開発で画面仕様書などのドキュメントを作成すると思います。 開発中や開発終了後、機能変更や追加が行われた場合、 既に作成されている仕様書も合わせて変更や追記される必要があると思います。 しかし、今の現場ではこのドキュメントの更新が徹底されておらず、 ドキュメントとアプリケーションの実際の仕様にギャップがあります。 機能の追加や変更があった場合に、 ドキュメントの更新を徹底させる何か良い方法はありませんでしょうか。
- 締切済み
- その他（プログラミング・開発）
- システム製作について設計書（ドキュメント）は必須でしょうか？
企業でシステム部門に従事している方 システム製作会社に勤務している方 に質問です。 企業のWebサイトや社内のシステムを自社製作する場合、または納品する場合ですが、システム設計書（ドキュメント）は必ず作る必要がありますか？ Webサイトの内容としては、会社案内サイトや商品販売などでお客様個人情報を扱うサイトです。社内システムとしてはグループウェアや社員の情報をあつかうシステムです。 特に上場企業の場合だと、日本版SOX法や新会社法などなどでシステムに関する対処がかなり要求されるようですが、そいった観点も含めて、やはりシステム設計書（ドキュメント）は必要になるものなのでしょうか？ お分かりの方、どんな些細な情報でも良いです。宜しくお願いします。
- ベストアンサー
- SE・インフラ・Webエンジニア
お礼
YkazubonYさん、 詳細に書いてくださり、助かりました。 上記の中から必要そうな資料を作成していきたいと思います。 有難うございました。