設計ドキュメント腐る問題、Git管理で運用してみた結果 | フューチャー技術ブログ
はじめにTIG真野です。 秋のブログ週間2023 の3本目は、設計ドキュメントをGit管理して腐らせないようにがんばってみた話をします。 前段として6年前、「我々はいかにシステム開発におけるドキュメント腐る問題と戦えば良いのか」という記事を書いたのですが、その後の試行錯誤はどこにも残していないことに気づきました。普段のフューチャー技術ブログですとちょっと引け目を感じるテーマですが、秋の夜長を楽しむため読み物成分を多めに書くというテーマのこのブログリレーにピッタリな気がするため、この機会をお借りします。 ドキュメントも色々な種別があるかと思いますが、この記事では設計ドキュメントを指すことにします。設計ドキュメントは開発メンバーが参照するもので、ステークホルダーへの説明資料に引用して使うことはあれど、主目的は異なるという前提です。Design Docの場合もありますし、システム構成図、ERD、
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サーバをDockerで1分でサクッと構築＋VSCodeでプレビューする | SyachikuLOG
みなさん、システムのドキュメント作成に疲弊してませんか？ 私はいままで画面遷移図やワークフロー図などのシステムドキュメントはVisioやExcelで作っていました。ただVisioやExcelの場合にはシステムがある程度の大きさになってくると矢印が変なとこにくっついたり、配置が崩れたり（涙）結局、図面を作成するだけで時間がかかってしまう・・・そんな経験ありますよね・・・ そんな時、「PlantUML」というツールを使ってみたところ非常に簡単に図面が作れてしまいました！これは本当にマジで最高です！近年の中で一番オススメできるツールです！そこで今回はPlantUMLをDocker上にサクッと構築する方法をご紹介したいと思います。Dockerの環境があればさくっと5分以内で構築できます！ また、VSCodeのPlantUMLの拡張機能を追加することでリアルタイムで図面をプレビューする方法やMark
会議を爆速にする、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
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
