タグ

docに関するhiroakiunoのブックマーク (4)

  • 特別公開!アーキテクチャドキュメント|オブジェクトの広場

    はじめに この記事では、以前私たちが実際に関わった開発案件で作成した「アーキテクチャドキュメント」を公開します。 別に国宝のお寺の庭に入れるわけでもないのに、「特別公開!」などという表現はずいぶん仰々しいな、と思われる方もいらっしゃるかもしれません。しかし特定のお客様向けに作成し納品したドキュメントを、そのまま外部に公開してしまうような例を、私自身はあまり聞いたことがありません。 これって結構特別だと思うのですが、手前味噌でしょうか? システムの概要 ご紹介する開発案件の名称は「新石炭総合OAシステム」といいます。これは、宇部興産株式会社殿で使われる社内システムで、在庫管理、販売管理などの機能を提供する典型的なビジネスアプリケーションです。 開発主体は株式会社宇部情報システム殿です。弊社(オージス総研)は、プロジェクトの立ち上げ期間の約3ヶ月間、2名が参加し、概念モデリングのコンサルティン

    hiroakiuno
    hiroakiuno 2008/09/09
    4+1ビューに従った実際のアーキテクチャドキュメント例
  • アーキテクチャドキュメントに必要なこと [arch]

    最近腰を入れて大掛かりなアーキテクチャ設計をしようとしているが,ドキュメントを書く際にいつも帰ってくるのがこのエントリー. Hitchhiker's Guide to Software Architecture and Everything Else - by Michael Stal: What should be in an Architecture Document? とても素晴らしい内容なので,以下に意訳しておきます.ぜひ原文も合わせて読んでみて下さい. - ドメインモデル (もしあれば),使用されているパターン,ガイドラインなどに特化したドキュメントを合わせて紹介すること.アーキテクチャドキュメントは,それらのガイドラインと整合性を保つこと. - 1つのドキュメントは50ページを超えないこと.肥大化したドキュメントは誰にも読まれない (少なくともその全ての内容は). - 当たり

    hiroakiuno
    hiroakiuno 2007/10/03
    良いドキュメントに仕上げてやろうというこのような心構えが何より重要だと思う。
  • HowToWriteAnEffectiveDesignDocument - 設計文書のうまい書き方

    HowToWriteAnEffectiveDesignDocument - 設計文書のうまい書き方 目次 この文書について 設計文書のうまい書き方 なぜ設計文書を書くのか 良い設計とは何か 同僚の開発者に向けて書く 第 1 節に書くこと: プロジェクト/サブシステムの目的を示す 第 2 節に書くこと: 設計に使う高レベルなエンティティを定義する 第 3 節に書くこと: 個々のエンティティに関する低レベルの設計を書く 使い方 設定 モデル 相互作用 第 4 節に書くこと: 利点, 前提, リスク/懸念事項 マネージャ向けに書くこと 最後に 設計文書のうまい書き方 この文書について "How to Write an Effective Design Document" の日語訳です. http://blog.slickedit.com/?p=43 推敲歓迎: 誤訳, タイポ, 訳語の不統一,

    hiroakiuno
    hiroakiuno 2007/09/26
    設計文書には、設計上の判断から得られる利点を漏らさず書くこと
  • 【特集】使ってる? Issue Tracking - trac 楽々ことはじめ (1) パニックプロジェクトを生まないために | エンタープライズ | マイコミジャーナル

    プロジェクトの情報共有を支えるための重要なタスクにドキュメンテーションと文書管理がある。あなたのプロジェクトでは適切な文書管理がなされているだろうか。通常、プロジェクトからは日々多くの種類/フォーマットの文書が生み出されている。そのため、文書管理に統制の無いプロジェクトでは、どこにある何を見ればいいのかを把握することでさえ、たちまち容易ではなくなってしまう。 プロジェクトに関する情報が増えてくる前に、一人でプロジェクト開発に従事しているあなたも、チームで開発をしているあなたも、散在する情報を整理したいと考えることだろう。 「今、プロジェクトで何が問題になっていて、何を片付けないといけないか」という情報群--ToDoやタスクリストとも表現できるこれらの情報群は、プロジェクト中のさまざまなシーンで出現し、これが管理されていないプロジェクトは、ほぼ確実に混乱に陥る。問題管理で取り扱う情報の種類は

    hiroakiuno
    hiroakiuno 2007/09/19
    ドキュメント管理
  • 1