はじめにフューチャー技術ブログのリレー形式の連載である、春の入門祭り2023の1日目です。TIG真野です。 ここ数年、Markdownで設計書をチームで書き、GitHub(GitLab)上でレビューするフローを採用しています。なるべくテキストベースで設計開発フローを統一するため、私の所属するチームでは以下のようなツールを採用しています。 シーケンス図、業務フロー図 Markdown中にPlantUMLで記載 参照はGitHub上からも見れるように、pegmatite を利用 システム構成図など画像系 Diagrams.net(draw.io)で作成し、.drawio.png の拡張子でMarkdownから参照 これだけは目視で差分チェックとなる Web API定義 OpenAPI SpecのYAMLファイル 参照はGitHub上からも見れるように、swagger-viewer を利用 ER
![markdownlintで設計書の品質を高める | フューチャー技術ブログ](https://cdn-ak-scissors.b.st-hatena.com/image/square/cd9f37a209477de9dbaf2f7957ec29da60a39a6c/height=288;version=1;width=512/https%3A%2F%2Ffuture-architect.github.io%2Fimages%2F20230417b%2FMicrosoft.VisualStudio.Services.Icons.png)