設計ドキュメント腐る問題、Git管理で運用してみた結果 | フューチャー技術ブログ
はじめにTIG真野です。 秋のブログ週間2023 の3本目は、設計ドキュメントをGit管理して腐らせないようにがんばってみた話をします。 前段として6年前、「我々はいかにシステム開発におけるドキュメント腐る問題と戦えば良いのか」という記事を書いたのですが、その後の試行錯誤はどこにも残していないことに気づきました。普段のフューチャー技術ブログですとちょっと引け目を感じるテーマですが、秋の夜長を楽しむため読み物成分を多めに書くというテーマのこのブログリレーにピッタリな気がするため、この機会をお借りします。 ドキュメントも色々な種別があるかと思いますが、この記事では設計ドキュメントを指すことにします。設計ドキュメントは開発メンバーが参照するもので、ステークホルダーへの説明資料に引用して使うことはあれど、主目的は異なるという前提です。Design Docの場合もありますし、システム構成図、ERD、
PlantUML で始めるリレーションシップ駆動要件分析 (RDRA) - Qiita
はじめに ソフトウェア開発において、エンジニアが開発対象のドメインの業務に精通していない場合、書く内容やかける時間に程度はあれど 業務分析 や 要件定義 が必要になります。しかし、要件定義の方法論についての話題がネット上に上がることも少なく、書籍などもあまり話題になっていない印象があります (私の観測範囲では)。なので、私の場合、要件定義の実務では公の方法論を体系的に学ばずに、実務で見てきたものを自分なりにアレンジして対応してきました。 そんなとき、モデルベースの要件定義の方法論として リレーションシップ駆動分析 (RDRA) というものがあることを知りました。モデリングはずっと取り組んできていることなので、興味が湧いて少し調べてみると PlantUML でも表現できるというではありませんか！ PlantUML Example for RDRA 2.0 ハンドブック そこで、RDRA2.0
【永久保存版】OAuth 2.0 / OpenID Connect シーケンスまとめ - Qiita
こんにちは、kuraです。 この記事はDigital Identity技術勉強会 #iddance のアドベントカレンダーの12日目の記事です。 開発チームを離れてプロジェクトやサービスのマネジメントが中心の業務になっており、コーディングを全然しなくなったのですが、上流工程でシーケンス図はよく書くため、自身の作業効率を上げる意味も含めて今回はOAuth 2.0やOpenID Connectのシーケンス図をまとめようと思います。 画像だけでなくPlantUMLのコードも掲載しておくので、みなさんにも活用いただけたらと思います。 PlantUMLについて PlantUMLはクラス図やシーケンス図がかけるオープンソースの描画ツールです。Qiitaにも記事をまとめてくださっている方はたくさんいるので詳しい情報は検索してみてください。 筆者は以下のあたりを参考にVSCodeとの組み合わせで作成してい
Visual Studio Code で UML を描こう！ - Qiita
この記事では、Windows 環境に Visual Studio Code と PlantUML をセットアップする手順を説明します。 PlantUML とは PlantUML は、以下のような図をテキストで素早く描くためのオープンソースプロジェクトです。 シーケンス図 / Sequence diagram ユースケース図 / Usecase diagram クラス図 / Class diagram アクティビティ図 / Activity diagram コンポーネント図 / Component diagram 状態遷移図 / State diagram オブジェクト図 / Object diagram 環境 下記の環境で動作確認しました。 Windows 10 Pro (64bit) Visual Studio Code 1.11 Java SE Runtime Environment
チームで機能設計するためのPlantUML標準化 | フューチャー技術ブログ
はじめに現在所属しているプロジェクトではWebAPIやバッチ処理の設計の一環としてPlantUMLを利用しています。効率よく品質高くアウトプットを出すためには、プログラミング言語に対してコーディング規約があるように、UMLに対してもチームで設計するにあたり一定のルールを決める必要があります。 そこでプロジェクト内のPlantUMLを使用するうえでのガイドラインやルールをまとめる機会があり、せっかくなのでそれを記事化します。 記事のゴール シーケンス図設計におけるPlantUMLの標準化 必要最低限のルールだけに絞ってチーム設計の生産性と品質を上げる 記事の前提 ルールの想定の利用シーン： チームで大量生産する業務機能の処理フローを表現するために使う場合を想定。 また、この記事に記載されているルールはRDBを中心的に使用したAPI処理やバッチ処理等を念頭に置き決められたものです。 ルールの想
PlantUMLのテーマ（思わぬ展開） | フューチャー技術ブログ
秋のブログ週間連載の7本目です。 はじめにPlantUMLで使えるテーマについてのご紹介です。 以前、チームで機能設計するためのPlantUML標準化の記事でも書かせていただきましたが、PlantUMLのデフォルトカラーって少しドライですよね。 色の好みは人それぞれで、あれはあれでカッコよさはありますが、複雑な図は少しでも可愛く描きたい・楽しく見たいものです。 この記事ではPlantUMLのテーマについて、いくつかのオプションを紹介していきます。「PlantUMLの色を変えてみたい！」という方は是非ご活用いただければ嬉しいです。 前提 PlantUMLでは、skinparamを利用して図のビジュアル各要素を定義しますが、「テーマ」はskinparamの集合体です この記事ではテーマの作り方や、各運用方法等については触れません この記事で紹介するオリジナルテーマはシーケンス図のために作られた
PlantUML使い方メモ - Qiita
長くなるので、図の書き方はクラス図とシーケンス図だけで。 その他の図については 続・PlantUML使い方メモ #PlantUML - Qiita を参照。 PlantUML とは テキストで UML 図を記述できる DSL の一種（たぶん） 本体は Java で書かれていて、単一の jar ファイルを落としてきてコマンドラインから実行できる plantuml/plantuml: Generate UML diagram from textual description ただし、実際に使うときは Visual Studio Code とかのプラグインを入れて実行することが多いと思う ライセンスは GPL v3 plantuml/license.txt at master · plantuml/plantuml 環境構築 OS は Windows10。 Java > java --versi
PlantUMLサーバをDockerで1分でサクッと構築＋VSCodeでプレビューする | SyachikuLOG
みなさん、システムのドキュメント作成に疲弊してませんか？ 私はいままで画面遷移図やワークフロー図などのシステムドキュメントはVisioやExcelで作っていました。ただVisioやExcelの場合にはシステムがある程度の大きさになってくると矢印が変なとこにくっついたり、配置が崩れたり（涙）結局、図面を作成するだけで時間がかかってしまう・・・そんな経験ありますよね・・・ そんな時、「PlantUML」というツールを使ってみたところ非常に簡単に図面が作れてしまいました！これは本当にマジで最高です！近年の中で一番オススメできるツールです！そこで今回はPlantUMLをDocker上にサクッと構築する方法をご紹介したいと思います。Dockerの環境があればさくっと5分以内で構築できます！ また、VSCodeのPlantUMLの拡張機能を追加することでリアルタイムで図面をプレビューする方法やMark
Visual Studio CodeでPlantUMLを使うメモ (Windows編).md
Visual Studio CodeでPlantUMLを使うメモ (Windows編).md Visual Studio CodeでPlantUMLを使うメモ (Windows編).md PlantUMLとは？ テキストベースの独自の記述言語を使って、UML図を描くことができるツール。 http://plantuml.com/ja/ ユースケース図、クラス図、シーケンス図、アクティビティ図などを描くことが可能。 Graphvizのインストール PlantUMLはdotを使って図を作成するので、あらかじめGraphvizをインストールしておく必要がある。 以下URLから、stable版のインストーラをダウンロード＆インストールする。 https://www.graphviz.org/download/ Javaのインストール OpenJDKを使う場合はこちらからダウンロード。 http://
Visual Studio Codeによるソフトウェア開発ノウハウ | Yu'n Craft
Visual Studio Codeによるソフトウェア開発ノウハウ Visual Studio Codeは、Microsoftが提供している無料で軽量、かつ強力なコードエディタです。 Visual Studio Codeによるソフトウェア開発に関する各種のノウハウを紹介します。
シンプルなテキストファイルで UML が書ける、オープンソースのツール
🌱 一目でわかるPlantUML 🚀 はじめに PlantUMLは、様々なダイアグラムを迅速かつ簡単に作成できる、非常に多目 的なツールです。 シンプルで直感的な言語を利用することで、ユーザは様々なタイプのダイアグラム を簡単に作成することができます。 この言語の機能とシンタックスの詳細については、PlantUML Language Reference Guide をご参照ください。 PlantUML を初めてお使いになる場合には、 を素早く立ち上げて実行するために、クイック・スタート・ ページから始めることをお勧めします。 さらに、PlantUML は、ワークフローを強化するために、他のさまざまなツールと シームレスに統合することができます。 🧩 サポートされる UML 図 PlantUML を使用することで、以下のような構造化された UML 図を作成することができます： シーケン
会議を爆速にする、Visual Studio Code 超便利スニペット集 - Qiita
以前の投稿でVisual Studio CodeとMarkdown Preview Enhanced環境を組み合わせの便利さを紹介しました。 議事メモを作成にマークダウンを使うと、議論が構造化されて表示されるので、非常にわかりやすくなりますね。みなさんもお使いかと思います。本稿では、そこに、更にVisual Studio Codeにマークダウン用のスニペットを登録しておくことを提案します。 出席者の議論をフォーカスさせる図や表がスムーズに呼び出せますので、効率的な会議を行うことができます。そんな爆速会議に便利なスニペットをいくつか紹介します。 以下ではVisual Studio CodeエディタとMarkdown Preview Enhancedプラグインが前提となっております。環境構築には以前の投稿をご参照ください。 1.会議を一気に立ち上げる：議事録スニペット まずは議事録のテンプレー
Visual Studio Code + MarkDown + PlantUML で開発ドキュメントをわかりやすくする - Qiita
きっかけ githubなどのソース管理ツールで新規のリポジトリを作成したり、フレームワークのプロジェクトを作成したりすると、Readme.mdができる。 Markdownは流行りというか、Qiitaでもお馴染みだし使いやすい。 しかし、画像（というか図）はどこかで作ってリンクするなど、ちょっと面倒だった。 そんな中、こんな記事を見る。 https://qiita.com/kitfactory/items/31cdf80cf1d3d8b42de8 「ああ、Markdownで図が描ける」 ということで、さっそく導入しようとしたのだが、最初の？？？となったところをまとめておく。 導入手順 Windows環境にVSCodeは既にインストール済みであることは前提として、次の手順が必要となる。 VSCodeの拡張機能で、「Markdown Preview Enhanced」をインストール 以下URLか
Visual Studio Code + Markdown Preview Enhancedはチームでデファクト化したいMarkdown環境だ！、と思う�(2017/10月時点) - Qiita
Visual Studio Code + Markdown Preview Enhancedはチームでデファクト化したいMarkdown環境だ！、と思う�(2017/10月時点)MarkdownエディタVSCodeVisualStudioCode 0.注意書き 筆者の本稿での意図はエディタ宗教論争を巻き起こすことではありません。「世の中では、これくらいのことが出来るようになってきている」とご参考にしてただくことが本稿の狙いです。それによって何かのお役に立てれば幸いだなと思っています。 皆さんは自分の使いやすい、皆さんの用途やプロジェクトの環境をにあったエディタを使用していただければとお断りしておきます。 1.Markdown環境について Markdwonは以前に書いたように今後の文書生産性を変えていく可能性のあるツールの一つです。Markdownのメリットは次の点だと思います。 1.1.M
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
PlantUML | プログラマーズ雑記帳
テキストから UML を生成する PlantUML についての解説記事を書いてみました。 PlantUML の使い方 (今回) シーケンス図 クラス図 オブジェクト図 パッケージ図 ユースケース図 アクティビティ図 状態遷移(ステートマシン)図 コンポーネント図 配置図 skinparam PlantUML 実行用のバッチファイル 今回は PlantUML の使い方の説明です。 PlantUML とは インストール 日本語 コマンドライン Doxygen との連携 Doxygen 連携用スクリプト その他のツールとの連携 オンラインデモ PlantUML とは 最近、プログラムの設計書などで UML を使うのが浸透してきていますが、 この UML を書くのはわりと面倒です。 CASE ツール, Doxygen などでは、クラス図を自動生成してくれますが、 ユースケース図やシーケンス図は自分
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
