Skip to content

Design — (<code>CVN-N<nnn></code>)<a class="headerlink" href="#design-cvn-nnnn" title="Permanent link">¶</a></h1> <p><strong>need_id</strong>: <code>CVN-N<nnn></code> <strong>Authors</strong>: <operator + any contributor> <strong>Reviewers</strong>: <if applicable> <strong>Status</strong>: <code>draft | accepted | superseded</code> <strong>Created</strong>: YYYY-MM-DD <strong>Last updated</strong>: YYYY-MM-DD</p> <h2 id="changelog">Changelog<a class="headerlink" href="#changelog" title="Permanent link">¶</a></h2> <table> <thead> <tr> <th>Date</th> <th>Change</th> </tr> </thead> <tbody> <tr> <td>YYYY-MM-DD</td> <td>Initial draft</td> </tr> </tbody> </table> <hr /> <h2 id="1-problem-restated">1. Problem restated<a class="headerlink" href="#1-problem-restated" title="Permanent link">¶</a></h2> <p><One paragraph re-stating the Need in technical terms. Link back to the Need doc.></p> <p><strong>Need doc</strong>: <code>documentation/needs/CVN-N<nnn>-<slug>.md</code></p> <h2 id="2-goals">2. Goals<a class="headerlink" href="#2-goals" title="Permanent link">¶</a></h2> <p><Measurable, scoped design goals that address the Need's KPIs.></p> <ul> <li>G1: ...</li> <li>G2: ...</li> </ul> <p><strong>Non-goals</strong>: <what this design deliberately doesn't solve></p> <h2 id="3-constraints">3. Constraints<a class="headerlink" href="#3-constraints" title="Permanent link">¶</a></h2> <p><Technical / business constraints that narrow the solution space.></p> <ul> <li>ADRs binding this design: <code><list></code></li> <li>Compute budget: <code><X pods × Yh></code></li> <li>Latency target: <code><if applicable></code></li> <li>Data available: <code><paths / ranges></code></li> </ul> <h2 id="4-options-considered">4. Options considered<a class="headerlink" href="#4-options-considered" title="Permanent link">¶</a></h2> <p><Minimum 2 options. Each with pros/cons/cost. The chosen option is §5; the rest live here as evidence the decision was deliberate.></p> <h3 id="option-a">Option A — <name><a class="headerlink" href="#option-a" title="Permanent link">¶</a></h3> <p><strong>Approach</strong>: <1 paragraph></p> <p><strong>Pros</strong>: - ...</p> <p><strong>Cons</strong>: - ...</p> <p><strong>Cost</strong>: <time/compute/complexity></p> <h3 id="option-b">Option B — <name><a class="headerlink" href="#option-b" title="Permanent link">¶</a></h3> <p>...</p> <h3 id="option-c">Option C — <name><a class="headerlink" href="#option-c" title="Permanent link">¶</a></h3> <p>...</p> <h2 id="5-decision">5. Decision<a class="headerlink" href="#5-decision" title="Permanent link">¶</a></h2> <p><strong>Chosen</strong>: Option <X>.</p> <p><strong>Rationale</strong>: <why this option wins given the constraints and goals>.</p> <p><strong>ADRs introduced</strong>: - <code>0064-<slug>.md</code> — <summary> - <code>0065-<slug>.md</code> — <summary></p> <h2 id="6-architecture">6. Architecture<a class="headerlink" href="#6-architecture" title="Permanent link">¶</a></h2> <p><Component diagram (Mermaid), data flow, API contracts. This is where implementers look first.></p> <pre class="mermaid"><code>graph LR A[Component A] -->|flow| B[Component B] </code></pre> <h2 id="7-implementation-plan">7. Implementation plan<a class="headerlink" href="#7-implementation-plan" title="Permanent link">¶</a></h2> <p><Broken into stories. Each story gets a doc in documentation/stories/.></p> <table> <thead> <tr> <th>Story</th> <th>Title</th> <th>Size</th> <th>Depends on</th> </tr> </thead> <tbody> <tr> <td>CVN-N<nnn>-US1</td> <td>...</td> <td>S</td> <td>—</td> </tr> <tr> <td>CVN-N<nnn>-US2</td> <td>...</td> <td>M</td> <td>US1</td> </tr> </tbody> </table> <h2 id="8-risks-mitigations">8. Risks + mitigations<a class="headerlink" href="#8-risks-mitigations" title="Permanent link">¶</a></h2> <h2 id="9-open-questions">9. Open questions<a class="headerlink" href="#9-open-questions" title="Permanent link">¶</a></h2> <p><Items the authors are unsure about. Addressed before <code>status: accepted</code>.></p> <ul class="task-list"> <li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Question 1</li> <li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Question 2</li> </ul> <h2 id="10-closure">10. Closure<a class="headerlink" href="#10-closure" title="Permanent link">¶</a></h2> <p><Filled when status → <code>accepted</code>. Link to the Need's closure section. If superseded, link the successor design doc.></p> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type="button" class="md-top md-icon" data-md-component="top" hidden> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg> Back to top </button> </main> <footer class="md-footer"> <nav class="md-footer__inner md-grid" aria-label="Footer" > <a href="../TEMPLATE_story/" class="md-footerlink md-footerlink--prev" aria-label="Previous: Story"> <div class="md-footerbutton md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </div> <div class="md-footertitle"> <span class="md-footer__direction"> Previous </span> <div class="md-ellipsis"> Story </div> </div> </a> <a href="../TEMPLATE_adr/" class="md-footerlink md-footerlink--next" aria-label="Next: ADR"> <div class="md-footertitle"> <span class="md-footerdirection"> Next </span> <div class="md-ellipsis"> ADR </div> </div> <div class="md-footerbutton md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-metainner md-grid"> <div class="md-copyright"> </div> <div class="md-social"> <a href="https://github.com/dococeven/champollion" target="_blank" rel="noopener" title="github.com" class="md-sociallink"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg> </a> </div> </div> </div> </footer> </div> <div class="md-dialog" data-md-component="dialog"> <div class="md-dialoginner md-typeset"></div> </div> <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.footer", "search.suggest", "search.highlight", "content.code.copy", "content.action.edit", "toc.follow"], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script> <script src="../../assets/javascripts/bundle.83f73b43.min.js"></script> </body> </html>