MarkdownとPlantUMLでソフトウェアの仕様書や設計書を書くための環境構築手順 - EurekaMoments
実践UML 第3版 オブジェクト指向分析設計と反復型開発入門 作者:クレーグ・ラーマンピアソンエデュケーションAmazon 目次 目次 はじめ Markdownで書くメリット Markdown記法一覧 環境構築手順 1. Visual Studio Codeをインストールする 2. PlantUMLをインストールする 3. Javaをインストールする 4. Graphvizをインストールする 5. Markdown Preview Enhancedをインストールする 環境構築後の動作確認 Markdownでドキュメントを書く際に便利な拡張機能 1. Paste Image 2. markdown-index 作成したドキュメントをHTMLやPDFに変換する 今回参考にさせていただいた記事 はじめ 自分はこれまでソフトウェア開発において仕様書や設計書を作成する際、Enterprise Arc
PHPソースからドキュメントを生成するツール
PHPソースからドキュメントを生成する主要な3ツールを試してみました。どのツールもそれほど深くは調べていないのでインストール＋アルファ程度の設定変更で試しています。 環境はCentOS4.4＋PHP5.2.3です。 phpDocumentor PHPでできたツールです。pearコマンドでインストールできることもあって、PHPのドキュメントジェネレータとして人気があります。 インストール pearコマンドでインストールできます。 $ pear install --alldeps phpdocumentor ドキュメント生成 phpdocコマンドで生成します。とりあえずドキュメントを生成するだけなら設定ファイルの変更は不要です。 ./src 以下のPHPファイルを対象に ./doc 以下にドキュメントを生成 $ phpdoc -t ./doc -d ./src [参考サイト] phpDocum
SandCastle Help File Builder を使ってみる
片桐 継 は こんなやつ かたぎり つぐ ってよむの 大阪生まれ河内育ちなんだけど 関東に住みついちゃったの 和装着付師だったりするの エセモノカキやってたりするの VBが得意だったりするの SQL文が大好きだったりするの 囲碁修行中だったりするの ボトゲ好きだったりするの F#かわいいよF# 正体は会った人だけ知ってるの 空気読まなくてごめんなさいなの わんくまリンク C# VB.NET掲示板 わんくま同盟Blog WindowsでGo言語 ネット活動 SNSは疲れました さて、ただいま病人は戦力外です＜おい といっても職場は暇どころか戦場真っ只中なわけで……、なので、このタイミングで開発ドキュメントを整備してしまおうなんて事を考えたところ、ふと、気がつきました。もはや凄まじい数のクラスメソッドプロパティ、こんなのWordやExcelになんてやってらんない。そこでMSDNみたくHelpフ
)
Microsoft Office SharePoint Server 2007 自習書シリーズ
Applies To: Office SharePoint Server 2007 Explore these links to find out more about how to implement Microsoft Office SharePoint Server 2007 or Windows SharePoint Services 3.0. Office SharePoint Server 2007 and Windows SharePoint Services 3.0 are collaboration environments that organizations of all sizes can use to increase the efficiency of business processes. SharePoint sites provide secure env
知るだけで天地の差が出る、テスト仕様書の必須項目＆表現方法
テスト仕様書で絶対に必要な項目リスト テスト仕様書に記述すべきものとして、以下の事項があります。 テストを実施した環境 実施するテストの内容 テストを実施するためのシステムの操作手順 テストの実行結果 個々のテスト項目を識別するための番号や記号（通し番号など） テストを実施した年月日 テストを実行した担当者 障害報告票番号（発生した障害の詳細を開発グループに報告する帳票の識別番号） まずはテスト環境について明記する テスト仕様書の先頭には、「テストを実施した環境」を記述します。ここでは、ハードウェア環境やソフトウェア環境、ネットワーク環境など、「どのような環境でテストを行ったか」を説明します。 ただし、テストを実施した環境を記述するだけでは十分ではありません。「顧客にとって必要な情報は何か」を考えるのです。ここで必要なのは、「要件定義書で規定した環境」との関係が分かることです。 なぜなら、
だれも教えてくれなかった外部設計の「極意」---目次
外部設計書で最も大切なことは，「システム開発を依頼してきたお客様」（発注者）に読んでもらい，理解してもらうことです。外部設計書を，開発メンバーではなく，発注者に理解してもらうためには，「いかに発注者にとって分かりやすい外部設計書を作成できるか」と「レビューを通じていかに合意形成を図るか」が重要になります。本連載では，発注者が理解しやすい外部設計書の書き方とレビューの方法に関する具体的なノウハウを解説していきます。 第1回 ユーザーと意思疎通が図れない外部設計書は危ない 第2回 ［システム振舞い編］一覧表に一工夫入れることで漏れや重複をなくす 第3回 ［システム振舞い編］全体を俯瞰でき，システム化範囲が一目で分かる業務フローを作成する 第4回 ［システム振舞い編］発注者が理解しやすいシナリオの記述方法 第5回 ［画面編］見れば“わかる”「画面レイアウト」の作り方 第6回 ［画面編］画面遷移を
phpDocumentor - PHPDocに代わるAPIドキュメント自動生成ツール - Do You PHP?
ずいぶん前にPHPDocを取り上げてあれこれ触ってみましたが、いつの間にかPEARマニュアルからページがなくなっていました。現在ではPHPDocの代わりに、高機能なphpDocumentorがPEARに追加されています。 phpDocumentor本家 PEARマニュアルのphpDocumentorのページ 基本的にはPHPDocと同じ「APIドキュメントを自動生成する」という機能だけなのですが出力形式が多様で、HTMLだけでもデザインテンプレートが何種類も用意されており、pear.php.netにあるAPIドキュメントでも採用されています。HTML以外にもPDF形式やWindowsのヘルプファイル用hhpファイル（別途コンパイルが必要）、はたまたpeardoc用docbookも出力できてしまいます。 今回はインストールからざっとした使い方までやってみました。 まずはインストールです。お決
phpDocumentor - phpspot
プログラムでドキュメントを書くのって面倒ですよね。 そこで javadoc 風なドキュメントを作成してくれる phpDocumentor の紹介です。 スクリプト中に /** * 概要 * phpDocumentorのサンプルです * * 説明 * phpDocumentorによって作成されました。 * * @param string $arg 説明 * * @return string 説明 */ function PACKAGE_fooFunc(){ } のような感じでコメントを書いておけばドキュメント化してくれます。 phpDocumentor用コメントの書き方 インストール phpDocumentor は pear でもインストールできますが、 今回は本家からファイルをダウンロードして進めます。 まず、ここからダウンロードします。 解凍すると、 のようにファイルが沢山できます。 (
phpDocumentorでドキュメントの自動生成
javaにはjavadocと言う、ソースファイルからjavaのリファレンスマニュアルを生成してくれるコマンドがありますが、phpにも同様のものとしてphpDocumentorがあります。これはPEARパッケージの１つとして提供されていて、PEARを導入していれば簡単にインストールが可能です。 phpDocumentorの特徴としては、ドキュメントのoutput形式として、下記のようなフォーマットがサポートされています。 html(複数のテンプレートから選択が可能) PDF Windows Help インストールはpearコマンドで簡単にインストール出来ますが、memory_limitがデフォルト値(8M)のままだとメモリー不足でインストール出来ませんでした、php.iniを修正してmemory_limitを16Mに増やせば問題なくインストール出来きました。 ;;;;;;;;;;;;;;;;
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Loading...
WordPress Codex 日本語版
http://onlineconsultant.jp/pukiwiki/?Doxygen%2FGraphviz%E3%81%A7%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3%E3%83%88%E3%82%92%E8%87%AA%E5%8B%95%E7%94%9F%E6%88%90%E3%81%99%E3%82%8B
共同編集も可能、雑多な知識をまとめ上げるための多目的Webノート「Piggydb」v4.2NOT SUPPORTED