« Uniqlo のいけてる Flash | メイン | showyou + Split Browser »

showyou --- HTML に Ajax でドキュメントを出力

ExecelやWordで画面仕様を管理していると、こんな問題に直面することありませんか?

・設計書の見た目に懲りすぎて作業がはかどらない。
・変更履歴を書くのが面倒。
・いざ障害が発生したらドキュメントよりソース優先だ。
・画面デザインが変更になるたび、画面イメージの張り替えが発生して発狂しそうになる。

そこで考えてみたのが、この showyou という仕組み。

外部のtextファイルにwikiフォーマットで記述したドキュメントを、実際の画面上に出力します。

画面仕様作成時、画面デザイン作成時、開発時などは、ドキュメントを出力し、本番環境ではshowyou ディレクトリの中に空のファイルを配置することで、ドキュメントを非表示にすることができます。

この方式でのメリットは以下の通り。

・開発環境では、画面の下に常にドキュメントが表示されているので、実際の動きとドキュメントの乖離に気が付きやすい。
・Subversion + Trac などを利用することで変更履歴をわざわざ書かなくても良い。
・実際の画面が仕様書になるので、画面イメージの張り替えがいらない。

まあ、実際どんなものかは見てもらった方が早いと思うので、こちらをご覧ください。

showyou sample --- 開発環境

showyou sample --- 本番環境

気になった方は、↓こちらからダウンロードしてみてください。

showyou をダウンロード
※2007.6.24 4:24 リンク先を version 0.0.2 に変更しました。

↓プロジェクトは Google code で管理しています。

showyou - Google Code

ご意見ご感想は、以下のメールアドレスか、本エントリのコメント・トラックバックでお願いします。

chris4403+showyou@gmail.com

あ、あと、海外進出をにらんで、インチキ英語で色々書いています。この辺りの添削も受け付けていますので、上記と同じ要領でご指摘頂ければと思います。

トラックバック

この一覧は、次のエントリーを参照しています: showyou --- HTML に Ajax でドキュメントを出力:

» showyou-0.0.2 Release 送信元 でぃべろっぱーず・さいど
Ajaxを利用してページにドキュメントを出力するツール showyou の ve... [詳しくはこちら]

コメント (4)

いやー、アニキ。あついじゃないっすか!

> ・画面デザインが変更になるたび、画面イメージの張り替えが発生して発狂しそうになる。

いますよ。発狂してる人。全国に。w

俺も前に↓を見て、へぇ~って思って、そんな見積り書を書いたことがあります。
http://event2.seasar.org/sc2006autumn/Session/SC2006Autumn_Aa4_Tips.pdf

外部設計書は書かずに、HTML(テンプレートエンジン使うから実際に本番でも動く)に
バンバン設計記述して、本番運用時はCSSで切り替えて~みたいなの。

んで、空ファイルって?って思ってたんだけど、
{display:none;}←俺はこっちの方が好きです♪

> ・Subversion + Trac などを利用することで変更履歴をわざわざ書かなくても良い。

これってコミットするときのコメントとユーザを
自動的にこのファイルに吐かせるってこと?

ちなみにTOEICでREADING265点でした・・。
添削ができるレベルではなかった模様ですw。スマソ(>_

>しのはら
でしょ!
俺も出羽さんのITプロか何かの記事を見たことがあって、なんとなくそれに近いことをやってみようかなーと思って作ってみたのさ。

空ファイルにしたのは、本番環境ではテキストファイルが見れる状況にしたくなかったから。

{display:none;}だと、FireBugsで見られちゃったり、そもそも.txtファイルのパスがばれたら直で見られちゃうわけで。
一応設計書なので、一般ユーザには見られちゃまずいよなぁと。

あと、Ajaxでデータ取ってきているので、ユーザの知らないところで変な通信を発生させるのも気持ち悪いかなーと思ったわけ。

で、.css、.txt、.jsについては、空ファイルを置いておけばスルーされるから何の問題もないかなと。

> これってコミットするときのコメントとユーザを自動的にこのファイルに吐かせるってこと?

あ、いやちゃいますわ。
変更履歴は、Tracのタイムラインとかで管理すれば良いかなぁと思っただけ。
でもSVNからファイルに書き出すモジュール作っても良いかもね。

>TOEIC
やっぱこれからは英語かなり必要だよね!
と言いつつ、TOEIC関係を一度も受けたことがなかったりするw

> {display:none;}だと~

なるほどなるほど。確かに!

> 変更履歴

履歴を細かく書くのが、ダルすぎるので、
(何ページ目の、1-1.を~とかやってると、そのうちページすらズレてきちゃったりさ。。)
最近は、お客さんに提出する時にだけ、
差分の内容をザックリ書くだけにしてます。。
(きっと書かなきゃいけない大事なこともいくつか漏れてると思うw)

テキストファイルならdiffれるし!

>(何ページ目の、1-1.を~とかやってると、そのうちページすらズレてきちゃったりさ。。)
分かるわー。

> テキストファイルならdiffれるし!

そう!
これがミソ!
やっぱテキストだよね。

後はお客さんに良さを説明して、導入できるかどうかがネックになるなぁ。SIer稼業の場合。