ドキュメント作成ツール

プロジェクト管理

要件定義・基本設計

要件定義書の一般的な項目

詳細設計・アルゴリズムなど

開発支援ツール

文書作成・管理

  • Excel方眼紙がダメな2つの理由 2012.7.13
    • まとめると、「Excel方眼紙」がダメな根源的な理由は2つある。プログラミングが合理化されない点、そして仕様情報管理が合理化されない点だ。これらに比べたら「Excelでは保守しづらい」とか「印刷するとずれる」など可憐なほどに瑣末である。
    • そういうわけで、この問題への対応状況には次の3段階がある。使っているツールがExcelだろうがWordだろうが、せめてレベル1を目指そう。レベル0の現場で人生を無駄使いしてはいけない。
      • <レベル0>汎用ツールで仕様書を書いて、いちいちプログラミングしている
      • <レベル1>汎用ツールで仕様書を書いて、プログラミングを合理化している
      • <レベル2>専用ツールで仕様書を書いて、プログラミングと仕様情報管理とを合理化している
  • 報告書の書き方 2011.10
       目標は何だったか
       その目標は達成されたか
       達成されたのは何が原因か
       達成できなかったのは何が原因か
       問題があった場合、解決のために自分はどんな努力をしたか
       解決できなかった問題は、どうすれば解決できるか
       そのためには何をしてほしいか
  • 仕様書の記述要領を決めるときに注意すべき一般的な項目
    • 大勢で仕様書を書くとき、平仄を合わせることが必要になり、以下のような規約をあらかじめ決めておく必要がある。決めて置かないと後から治すハメになる。
    • スペースの表現方法。△を使うか、クォートで囲うか。
    • 改ページしたときにヘッダを再度表示するか。表で改ページした場合も
    • 注のつけ方。章ごとに注の本体を書くのか、ページごとに書くのか
    • 章立て、項目立ての項番体系。単項目になったときに番号をつけるか(外すことが多い模様)
    • 既存の仕様書を修正で項番を削除するとき、詰めるのか、欠番にするのか。取り消し線を引くのか
    • ファイル名のつけ方のルール
    • 修正履歴の書き方。修正の理由も書くか。いつからバージョン1.0とするか
    • 図表の番号、キャプションのつけかた
    • Wordの場合、見出しにどんなスタイルをつけるか
    • テンプレート(.dot)を使うか
    • 英数字は全角か、半角か
  • ソフトウェアレビューが成功する進行役の6条件 2010.4.14
    • レビューアがエラー発見に集中できているか
    • レビューアがエラー発見の手掛かりを得られているか
    • 遠慮して発言していないレビューアがいないか
    • 適切なエラー指摘がなされているか
    • 進行のペース(時間配分)は適切か
    • 作成者は指摘を受け入れているか
  • どんな作業のマニュアルも3時間あれば作れる
    • 個人的には以下のようなマニュアル観は間違っていると思う。
      • 不完全なマニュアルを配られても困る
      • マニュアルに書いてある通りにやって問題が起きるぐらいなら、そんなの無いほうがいいんじゃないの
      • 書いてある通りにやって問題が起きても作業者の責任ではない。嘘のマニュアルを書いたやつが悪い
      • マニュアルとは「書いてある通りに作業するためのもの」なのだから、例外事項がたくさんある作業のマニュアルなんて書けない
      • マニュアルがあると、それに頼り切って頭を使わなくなるので、作業者が成長しなくなるのが問題だ
    • どこが間違っているかというと、こう考える組織では永遠にマニュアルができないから
  • 計画書をコピペしてはいけない 2008.4.8
    • 「参考にする」ということと「コピペ」するということは違う
    • ここはコピーしても大丈夫だろうと思っても,必ず一度自分の頭で考え,判断した上でコピペすべきである
  • 仕様書の意義
    • 仕様書について人々が犯す最大の過ちは、公式のレビュー会議を開催するまで内容のフィードバックを得ようとしないことです。レビューは確認と洗練を行うための場であり、たたき台の検討と最終決定を同時に行うための場ではありません

関連サイト

ツール

ドキュメント作成ツール

Markdown記法

Help File

PDF

  • 文書のPDF化
  • ConcatPDF
    • PDFの結合・抽出・暗号化などをしてくれるツール
  • Acrobat のエディション別の機能差一覧
  • PrimoPDF フリーのPDFコンバータ
  • PrimoPDFで出力したPDFをReaderで表示すると「フォントが無効なので削除」とか言われて文字化けして読めないとき
    • 以下のようにすると解決した
    • プリンタ(PrimoPDF)のプロパティを表示
    • 「全般」タブの「印刷設定」ボタン→「レイアウト」タブの「詳細設定」ボタン→「TrueType Font Download Option」を「Automatic」から「Outline」に変更
    • primo.PNG
    • (2006.9.20 最新バージョンでは解決している模様)

添付ファイル: fileprimo.PNG 1113件 [詳細]

トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2020-01-05 (日) 18:47:58 (469d)