Skip to content

LLD: <a class="headerlink" href="#lld" title="Permanent link">¶</a></h1> <p>status: draft</p> <p>Low-level design template (backlog B35). Copy to <code>docs/design/LLD-<slug>.md</code>; <code>mmdep design check</code> requires every section below. Replace the examples. Once Atul approves the design, change <code>status: draft</code> to <code>status: approved</code>; then <code>mmdep design issues <this file></code> shows (dry run) or opens (<code>--create</code>) one issue per Work items row.</p> <h2 id="context">Context<a class="headerlink" href="#context" title="Permanent link">¶</a></h2> <p>What problem this solves and which ADR it follows (for example ADR-0016).</p> <h2 id="decision">Decision<a class="headerlink" href="#decision" title="Permanent link">¶</a></h2> <p>What is built, in a few lines: interfaces, data, where it runs.</p> <h2 id="c4-element">C4 element<a class="headerlink" href="#c4-element" title="Permanent link">¶</a></h2> <p>The elements of the C4 model (architecture/workspace.dsl) this touches, each in backticks. A new component goes into the model first.</p> <ul> <li><code>MMDEP</code></li> </ul> <h2 id="diagram">Diagram<a class="headerlink" href="#diagram" title="Permanent link">¶</a></h2> <p>Required when more than two parts interact (docs/design/visualization-standard.md): a Mermaid <code>flowchart</code>, <code>sequenceDiagram</code>, <code>stateDiagram</code> or <code>erDiagram</code>. Mark planned or unverified parts.</p> <pre class="mermaid"><code>flowchart LR A[Caller] --> B[New component] --> C[(Store)]</code></pre> <h2 id="test-plan">Test plan<a class="headerlink" href="#test-plan" title="Permanent link">¶</a></h2> <ul> <li>Unit tests for the new behaviour; the contract test that fails before the change.</li> </ul> <h2 id="risk">Risk<a class="headerlink" href="#risk" title="Permanent link">¶</a></h2> <p>risk: low</p> <p>Why, and what would make it higher (contract, secrets, production, money).</p> <h2 id="work-items">Work items<a class="headerlink" href="#work-items" title="Permanent link">¶</a></h2> <table> <thead> <tr> <th>#</th> <th>Title</th> <th>Risk</th> <th>Model</th> <th>Scope paths</th> <th>Depends on</th> <th>Cx</th> <th>Tests</th> </tr> </thead> <tbody> <tr> <td>1</td> <td>Example item</td> <td>low</td> <td>gemini-flash-lite</td> <td>mmdep/example.py, tests/test_example.py</td> <td></td> <td>2</td> <td>tests/test_example.py</td> </tr> <tr> <td>2</td> <td>Example follow-up</td> <td>low</td> <td>gemini-flash-lite</td> <td>docs/example.md</td> <td>1</td> <td>1</td> <td></td> </tr> </tbody> </table> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> </main> <footer class="md-footer"> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class="md-copyright"> Made with <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> Material for MkDocs </a> </div> </div> </div> </footer> </div> <div class="md-dialog" data-md-component="dialog"> <div class="md-dialog__inner md-typeset"></div> </div> <script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.sections", "navigation.indexes", "search.suggest", "content.code.copy"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "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"}, "version": null}</script> <script src="../../assets/javascripts/bundle.c21346df.min.js"></script> </body> </html>