<p data-line="0" class="code-line">本記事は<a href="https://qiita.com/advent-calendar/2024/coconala_engineer" target="_blank" rel="nofollow noopener noreferrer">株式会社ココナラ Advent Calendar 2024</a> 18日目の記事です。</p>
<h2 id="%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB" data-line="3" class="code-line">
<a class="header-anchor-link" href="#%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB" aria-hidden="true"></a> はじめに</h2>
<p data-line="4" class="code-line">こんにちは。<br>
株式会社ココナラ 経済圏共通基盤開発チームの<strong>fumi</strong>と申します。<br>
私たちのチームでは、エンジニアが安心・安全に開発していくためにDesign Docを導入しました。<br>
今回はなぜ導入に至ったのか、Design Docによって得られるメリットについて書きたいと思います。</p>
<h2 id="design-doc%E3%81%A8%E3%81%AF%EF%BC%9F" data-line="9" class="code-line">
<a class="header-anchor-link" href="#design-doc%E3%81%A8%E3%81%AF%EF%BC%9F" aria-hidden="true"></a> Design Docとは？</h2>
<p data-line="10" class="code-line">Design Docとは、システムの設計に関する思想、指針、具体的な設計などを文章化したものです。<br>
具体的には、アーキテクチャやシステムの構成、技術選定、テスト方針など、開発における重要な要素を整理した文章で、プロジェクトに関わるすべてのメンバーが共通の認識を持つためのツールです。</p>
<h2 id="%E3%81%AA%E3%81%9Cdesign-doc%E3%81%8C%E5%BF%85%E8%A6%81%E3%81%AA%E3%81%AE%E3%81%8B%EF%BC%9F" data-line="13" class="code-line">
<a class="header-anchor-link" href="#%E3%81%AA%E3%81%9Cdesign-doc%E3%81%8C%E5%BF%85%E8%A6%81%E3%81%AA%E3%81%AE%E3%81%8B%EF%BC%9F" aria-hidden="true"></a> なぜDesign Docが必要なのか？</h2>
<p data-line="14" class="code-line">共通基盤開発は、多様なステークホルダーが関わり、システムのライフサイクルが長期にわたるという特性上、設計に関する情報共有の不足や、開発の遅延が懸念されます。<br>
そこで、経済圏共通基盤開発チームでは、これらの課題解決のため、Design Docを導入することにしました。</p>
<h2 id="design-doc%E3%82%92%E5%B0%8E%E5%85%A5%E3%81%97%E3%81%9F%E3%83%A1%E3%83%AA%E3%83%83%E3%83%88" data-line="17" class="code-line">
<a class="header-anchor-link" href="#design-doc%E3%82%92%E5%B0%8E%E5%85%A5%E3%81%97%E3%81%9F%E3%83%A1%E3%83%AA%E3%83%83%E3%83%88" aria-hidden="true"></a> Design Docを導入したメリット</h2>
<p data-line="18" class="code-line">Design Docを導入したことで、以下のようなメリットを得ることができました。</p>
<h3 id="1.-%E8%A8%AD%E8%A8%88%E6%80%9D%E6%83%B3%E3%81%AE%E5%8F%AF%E8%A6%96%E5%8C%96%E3%81%A8%E5%85%B1%E6%9C%89" data-line="20" class="code-line">
<a class="header-anchor-link" href="#1.-%E8%A8%AD%E8%A8%88%E6%80%9D%E6%83%B3%E3%81%AE%E5%8F%AF%E8%A6%96%E5%8C%96%E3%81%A8%E5%85%B1%E6%9C%89" aria-hidden="true"></a> 1. <strong>設計思想の可視化と共有</strong>
</h3>
<ul data-line="21" class="code-line">
<li data-line="21" class="code-line">
<strong>思想、指針の明確化</strong>: 抽象的な思想や指針を具体的な設計に落とし込むことで、関係メンバー全員が共通認識を持ち開発を進められます。</li>
<li data-line="22" class="code-line">
<strong>情報共有の効率化</strong>: 設計思想を文書化することで、関係メンバー間での情報、認識共有がスムーズになり誤解を防ぐことができます。</li>
<li data-line="23" class="code-line">
<strong>レビューの促進</strong>: Design Docを共有し、設計思想に対するフィードバックを早期に得ることで、設計の品質を向上させることができます。</li>
</ul>
<h3 id="2.-%E8%A8%AD%E8%A8%88%E3%81%AE%E6%A4%9C%E8%A8%BC%E3%81%A8%E6%94%B9%E5%96%84" data-line="25" class="code-line">
<a class="header-anchor-link" href="#2.-%E8%A8%AD%E8%A8%88%E3%81%AE%E6%A4%9C%E8%A8%BC%E3%81%A8%E6%94%B9%E5%96%84" aria-hidden="true"></a> 2. <strong>設計の検証と改善</strong>
</h3>
<ul data-line="26" class="code-line">
<li data-line="26" class="code-line">
<strong>設計の整合性チェック</strong>: Design Docを作成し、レビューすることで、設計に矛盾や抜け漏れがないかを確認できます。</li>
<li data-line="27" class="code-line">
<strong>問題の早期発見</strong>: 設計段階でDesign Docと照合する事で、問題点を発見でき開発後の手戻りを減らすことができます。</li>
<li data-line="28" class="code-line">
<strong>代替案の検討</strong>: Design Docを作成する過程で、様々な代替案を検討し、最適な設計を選択することができます。</li>
</ul>
<h3 id="3.-%E9%96%8B%E7%99%BA%E3%81%AE%E5%8A%B9%E7%8E%87%E5%8C%96" data-line="30" class="code-line">
<a class="header-anchor-link" href="#3.-%E9%96%8B%E7%99%BA%E3%81%AE%E5%8A%B9%E7%8E%87%E5%8C%96" aria-hidden="true"></a> 3. <strong>開発の効率化</strong>
</h3>
<ul data-line="31" class="code-line">
<li data-line="31" class="code-line">
<strong>開発タスクの明確化</strong>: Design Docに基づいて開発タスクを明確化することで、開発者は何をすべきかを明確に理解し、効率的に開発を進めることができます。</li>
<li data-line="32" class="code-line">
<strong>開発期間の短縮</strong>: 設計段階でDesign Docと照合し問題点を洗い出すことで、開発期間を短縮することができます。</li>
<li data-line="33" class="code-line">
<strong>コードの品質向上</strong>: Design Docに基づいて開発することで、設計意図を理解した上でコードを書くことができ、コードの品質向上につながります。</li>
</ul>
<h3 id="4.-%E7%B5%84%E7%B9%94%E7%9A%84%E3%81%AA%E7%9F%A5%E8%AD%98%E3%81%AE%E8%93%84%E7%A9%8D" data-line="35" class="code-line">
<a class="header-anchor-link" href="#4.-%E7%B5%84%E7%B9%94%E7%9A%84%E3%81%AA%E7%9F%A5%E8%AD%98%E3%81%AE%E8%93%84%E7%A9%8D" aria-hidden="true"></a> 4. <strong>組織的な知識の蓄積</strong>
</h3>
<ul data-line="36" class="code-line">
<li data-line="36" class="code-line">
<strong>ナレッジベースの構築</strong>: Design Docを蓄積することで、組織全体のナレッジベースを構築し、新しいメンバーがスムーズにプロジェクトに参加できるようになります。</li>
<li data-line="37" class="code-line">
<strong>技術継承の促進</strong>: 設計に関する情報を文書化しておくことで、担当者が変わっても円滑に開発を引き継ぐことができます。</li>
</ul>
<h3 id="5.-%E6%84%8F%E6%80%9D%E6%B1%BA%E5%AE%9A%E3%81%AE%E6%94%AF%E6%8F%B4" data-line="39" class="code-line">
<a class="header-anchor-link" href="#5.-%E6%84%8F%E6%80%9D%E6%B1%BA%E5%AE%9A%E3%81%AE%E6%94%AF%E6%8F%B4" aria-hidden="true"></a> 5. <strong>意思決定の支援</strong>
</h3>
<ul data-line="40" class="code-line">
<li data-line="40" class="code-line">
<strong>根拠に基づいた意思決定</strong>: Design Docに記載された情報に基づいて、設計に関する意思決定を行うことができます。</li>
<li data-line="41" class="code-line">
<strong>リスクの評価</strong>: 設計に潜むリスクを事前に評価し、対策を講じることができます。</li>
</ul>
<h2 id="design-doc-guide%E3%81%AE%E4%BD%9C%E6%88%90%E3%81%A8%E5%85%A8%E7%A4%BE%E5%B1%95%E9%96%8B" data-line="43" class="code-line">
<a class="header-anchor-link" href="#design-doc-guide%E3%81%AE%E4%BD%9C%E6%88%90%E3%81%A8%E5%85%A8%E7%A4%BE%E5%B1%95%E9%96%8B" aria-hidden="true"></a> Design Doc Guideの作成と全社展開</h2>
<p data-line="44" class="code-line">Design Docのメリットを最大限に活かすため、私たちチームでは、Design Doc Guideを作成しました。<br>
このガイドには、Design Docの作成のメリット、注意点などを詳細に記述してあります。<br>
全社的にDesign Docを作成する文化を醸成するため、作成したDesign Doc Guideを展開しました。</p>
<h2 id="%E3%81%BE%E3%81%A8%E3%82%81" data-line="48" class="code-line">
<a class="header-anchor-link" href="#%E3%81%BE%E3%81%A8%E3%82%81" aria-hidden="true"></a> まとめ</h2>
<p data-line="49" class="code-line">Design Docを導入したことで、チーム全体で共通の認識を持つことができ、開発がスムーズに進むだけでなく、設計品質、コード品質向上にもつながりました。<br>
今後は、Design Docを書く文化を全社に根付かせ、より良いソフトウェア開発を目指していきます！</p>
<hr data-line="52" class="code-line">
<p data-line="54" class="code-line">明日は<a href="https://qiita.com/Kou_arbn" target="_blank" rel="nofollow noopener noreferrer">@Kou_arbn</a>さんによる<strong>PagerDutyでサービス分割時のオンコール体制変更に対応する</strong>です。</p>
<p data-line="56" class="code-line">ココナラでは積極的にエンジニアを採用しています。<br>
特にPlatform Engineer は今すぐにでも一緒に働きたいのでJD をご一読ください<br style="display:none">
<span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__2aa125a0e4c7f" src="https://embed.zenn.studio/card#zenn-embedded__2aa125a0e4c7f" data-content="https%3A%2F%2Fopen.talentio.com%2Fr%2F1%2Fc%2Fcoconala%2Fpages%2F99346" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://open.talentio.com/r/1/c/coconala/pages/99346" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://open.talentio.com/r/1/c/coconala/pages/99346</a><br style="display:none">
採用情報はこちら。<br style="display:none">
<span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__a6a82b6c91fa2" src="https://embed.zenn.studio/card#zenn-embedded__a6a82b6c91fa2" data-content="https%3A%2F%2Fcoconala.co.jp%2Frecruit%2Fengineer%2F" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://coconala.co.jp/recruit/engineer/" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://coconala.co.jp/recruit/engineer/</a></p>
<p data-line="62" class="code-line">カジュアル面談希望の方はこちら。<br style="display:none">
<span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__10206b385247b" src="https://embed.zenn.studio/card#zenn-embedded__10206b385247b" data-content="https%3A%2F%2Fopen.talentio.com%2Fr%2F1%2Fc%2Fcoconala%2Fpages%2F70417" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://open.talentio.com/r/1/c/coconala/pages/70417" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://open.talentio.com/r/1/c/coconala/pages/70417</a></p>


Design Docはじめました

設計思想

designdoc

Discussion