Python Desgin Doc

概要

プロジェクトタイトル:Python Design Doc
開発日:2011/08/27
開発リーダー:Yuta kitagami
目的:プロジェクトの全体図を示すDesignDocを作成するためのエンジン
プロジェクト参加者:Yuta_Kitagami
関連するライブラリ:Python3.x,Sphinx,

動作内容

-背景:

開発者にとって仕様書を書く作業が好きな人はそんなに居ない。

開発者はなるべく早く開発に移りたいと考えるだろう。

なので、本プロジェクトは開発現場で仕様書の作成を一回の作業で終わらせるため、

基本的な情報を記述できるテンプレート及びジェネレーターを作成する。

-アーキテクチャ図:

../../_images/foo.jpg

-動作内容:

  1. テンプレ.txtを読み出す。
  2. 対話式に表示する。
  3. 入力を促する。
  4. rtsを出力する。
  5. 変更がある場合は2.に戻ってファイルを編集し直す。

-使用方法:

現在はCUIによる操作方法で開発する。

後にGUI操作による編集や、WEBベースでの編集を目標としている。

-利用場面:

  • 新規プロジェクトを立ち上げる際に使用する。
  • 誰が何を何のために作るのかをはっきりさせる。
  • 途中で変更があった際には、速やかに変更する。
  • 誰が見てもプロジェクトの内容が分かるようにする。

管理情報

動作環境:

All Python Platform

ライセンス:

GPL?

サイト情報:

http://www.kitagami.org/PyDDG.html

既存の不具合:
  • Bがとっても悪い。
  • AとBが悪い。
  • 特になし
トラブルシューティング:

–helpに記載 - 問題が起きたら連絡ください。

セキュリティー関連:

未定

バージョン履歴:

2011/08/28 ver0.0

メッセージ

メッセージ:

この文章はPythonDesignDocによって生成されました。

謝辞:

PythonおよびSphinxに感謝 手伝ってくれたPythonistの方々に感謝 自分を生んで育ててくれた家族と恋人にも感謝

連絡先:kitagami@artifactnoise.com

その他

メモ:

試し書きです。

Indices and tables