import{_ as s,c as a,o as n,a0 as i}from"./chunks/framework.FdfEk_gD.js";const g=JSON.parse('{"title":"Advanced Engineering","description":"","frontmatter":{},"headers":[],"relativePath":"user/advanced-engineering.md","filePath":"user/advanced-engineering.md"}'),t={name:"user/advanced-engineering.md"};function o(l,e,r,p,c,h){return n(),a("div",null,[...e[0]||(e[0]=[i(`<h1 id="advanced-engineering" tabindex="-1">Advanced Engineering <a class="header-anchor" href="#advanced-engineering" aria-label="Permalink to &quot;Advanced Engineering&quot;">​</a></h1><p>Beyond basic workflows, Responsible Vibe provides sophisticated engineering practices for serious software development.</p><h2 id="project-documentation-system" tabindex="-1">Project Documentation System <a class="header-anchor" href="#project-documentation-system" aria-label="Permalink to &quot;Project Documentation System&quot;">​</a></h2><h3 id="setup-project-docs-tool" tabindex="-1"><code>setup_project_docs</code> Tool <a class="header-anchor" href="#setup-project-docs-tool" aria-label="Permalink to &quot;\`setup_project_docs\` Tool&quot;">​</a></h3><p>Create structured project documentation that persists across conversations:</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># Your AI can call this automatically or you can request it</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">&quot;Set up project documentation using the arc42 template&quot;</span></span></code></pre></div><p><strong>What it creates:</strong></p><ul><li><code>architecture.md</code> – System design and technical decisions</li><li><code>requirements.md</code> – What you&#39;re building and why</li><li><code>design.md</code> – Detailed implementation approach</li></ul><p><strong>Template Options:</strong></p><ul><li><strong>arc42</strong>: Industry-standard architecture documentation</li><li><strong>comprehensive</strong>: Detailed templates for all aspects</li><li><strong>freestyle</strong>: Minimal structure, maximum flexibility</li><li><strong>none</strong>: Placeholder that references plan file instead</li></ul><p><strong>File Linking:</strong> Instead of creating new docs, you can link existing ones:</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">&quot;Link the existing README.md as architecture documentation&quot;</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># Creates symlink: .vibe/docs/architecture.md → README.md</span></span></code></pre></div><h2 id="workflow-variables" tabindex="-1">Workflow Variables <a class="header-anchor" href="#workflow-variables" aria-label="Permalink to &quot;Workflow Variables&quot;">​</a></h2><p>Your workflows can reference project documentation dynamically:</p><p><strong>In Workflow Instructions:</strong></p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>&quot;Review the system architecture documented in $ARCHITECTURE_DOC</span></span>
<span class="line"><span>and ensure your design addresses all requirements in $REQUIREMENTS_DOC.&quot;</span></span></code></pre></div><p><strong>At Runtime:</strong></p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>&quot;Review the system architecture documented in /project/.vibe/docs/architecture.md</span></span>
<span class="line"><span>and ensure your design addresses all requirements in /project/.vibe/docs/requirements.md.&quot;</span></span></code></pre></div><p><strong>Available Variables:</strong></p><ul><li><code>$ARCHITECTURE_DOC</code> → <code>.vibe/docs/architecture.md</code></li><li><code>$REQUIREMENTS_DOC</code> → <code>.vibe/docs/requirements.md</code></li><li><code>$DESIGN_DOC</code> → <code>.vibe/docs/design.md</code></li></ul><p>This makes workflows portable across projects while maintaining consistent structure.</p><h2 id="trunk-based-development" tabindex="-1">Trunk-Based Development <a class="header-anchor" href="#trunk-based-development" aria-label="Permalink to &quot;Trunk-Based Development&quot;">​</a></h2><h3 id="branch-specific-development-plans" tabindex="-1">Branch-Specific Development Plans <a class="header-anchor" href="#branch-specific-development-plans" aria-label="Permalink to &quot;Branch-Specific Development Plans&quot;">​</a></h3><p>Each git branch gets its own development plan file:</p><p><strong>Main branch:</strong> <code>development-plan.md</code><br><strong>Feature branch:</strong> <code>development-plan-feature-auth.md</code><br><strong>Bugfix branch:</strong> <code>development-plan-fix-login.md</code></p><h3 id="branch-specific-conversation-contexts" tabindex="-1">Branch-Specific Conversation Contexts <a class="header-anchor" href="#branch-specific-conversation-contexts" aria-label="Permalink to &quot;Branch-Specific Conversation Contexts&quot;">​</a></h3><p>Each branch maintains separate conversation context:</p><ul><li>Different conversation IDs based on <code>project-path + git-branch</code></li><li>Independent development phases and progress tracking</li><li>Separate plan files for each branch&#39;s development process</li></ul><p><strong>Switch branches, get separate context:</strong></p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">git</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> checkout</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> feature-auth</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># AI loads separate conversation context for this branch</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># Gets development-plan-feature-auth.md as process memory</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># Can reference .vibe/docs/ for long-term memory when needed</span></span></code></pre></div><h3 id="explicit-reference-documentation" tabindex="-1">Explicit Reference Documentation <a class="header-anchor" href="#explicit-reference-documentation" aria-label="Permalink to &quot;Explicit Reference Documentation&quot;">​</a></h3><p>Development plans serve as <strong>process memory</strong> (actively maintained by AI) but can also be <strong>explicitly referenced</strong>:</p><p><strong>Through Commits:</strong></p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">git</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> commit</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -m</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;implement user authentication</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">See development-plan-feature-auth.md for architectural decisions</span></span>
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">and requirements analysis from the planning phase.&quot;</span></span></code></pre></div><p>When your AI reads this commit, it can reference the plan file to understand the context and decisions made.</p><p><strong>Through Direct Reference:</strong></p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">&quot;Check @.vibe/development-plan-auth.md to see what we thought about back then&quot;</span></span></code></pre></div><h2 id="rule-files-integration" tabindex="-1">Rule Files Integration <a class="header-anchor" href="#rule-files-integration" aria-label="Permalink to &quot;Rule Files Integration&quot;">​</a></h2><h3 id="process-vs-deliverable-guidance" tabindex="-1">Process vs Deliverable Guidance <a class="header-anchor" href="#process-vs-deliverable-guidance" aria-label="Permalink to &quot;Process vs Deliverable Guidance&quot;">​</a></h3><p><strong>Responsible Vibe</strong> provides <strong>HOW of the process</strong> (what phase, what to focus on)<br><strong>Rule files</strong> provide <strong>HOW of the deliverables</strong> (coding standards, conventions)</p><p><strong>Example Rule File</strong> (<code>.kiro/rules/comments.md</code>):</p><div class="language-markdown vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">markdown</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-light-font-weight:bold;--shiki-dark:#E1E4E8;--shiki-dark-font-weight:bold;">**Use**</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> comments to explain the purpose of a variable/method/function/class.</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-light-font-weight:bold;--shiki-dark:#E1E4E8;--shiki-dark-font-weight:bold;">**Use**</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> meaningful variable/method/function/class names.</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-light-font-weight:bold;--shiki-dark:#E1E4E8;--shiki-dark-font-weight:bold;">**Avoid**</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> comments that describe what the code is doing.</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-light-font-weight:bold;--shiki-dark:#E1E4E8;--shiki-dark-font-weight:bold;">**Avoid**</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> comments that describe what&#39;s been changed in a development session.</span></span></code></pre></div><h3 id="how-they-work-together" tabindex="-1">How They Work Together <a class="header-anchor" href="#how-they-work-together" aria-label="Permalink to &quot;How They Work Together&quot;">​</a></h3><ol><li><strong>Responsible Vibe</strong>: &quot;You&#39;re in the implementation phase. Write clean, testable code.&quot;</li><li><strong>Rule Files</strong>: &quot;Use meaningful names. Avoid describing what code does in comments.&quot;</li><li><strong>Result</strong>: AI follows structured process AND coding standards</li></ol><h2 id="long-term-memory" tabindex="-1">Long-Term Memory <a class="header-anchor" href="#long-term-memory" aria-label="Permalink to &quot;Long-Term Memory&quot;">​</a></h2><h3 id="the-vibe-docs-structure" tabindex="-1">The <code>.vibe/docs/</code> Structure <a class="header-anchor" href="#the-vibe-docs-structure" aria-label="Permalink to &quot;The \`.vibe/docs/\` Structure&quot;">​</a></h3><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>.vibe/</span></span>
<span class="line"><span>├── docs/</span></span>
<span class="line"><span>│   ├── architecture.md    # System design decisions</span></span>
<span class="line"><span>│   ├── requirements.md    # What you&#39;re building</span></span>
<span class="line"><span>│   └── design.md         # Implementation approach</span></span>
<span class="line"><span>├── development-plan-main.md</span></span>
<span class="line"><span>├── development-plan-feature-auth.md</span></span>
<span class="line"><span>└── conversation-state.sqlite</span></span></code></pre></div><h3 id="explicit-reference-system" tabindex="-1">Explicit Reference System <a class="header-anchor" href="#explicit-reference-system" aria-label="Permalink to &quot;Explicit Reference System&quot;">​</a></h3><p><strong>Development plans are documentation, not automatic memory:</strong></p><ul><li><strong>Project decisions</strong> are documented in plan files for explicit reference</li><li><strong>Architectural choices</strong> are captured in <code>.vibe/docs/</code> for workflow variable substitution</li><li><strong>Development progress</strong> is tracked in plan files that can be referenced in commits</li><li><strong>Branch context</strong> provides separate conversation spaces, not automatic plan loading</li></ul><p><strong>How to use it:</strong></p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># Reference past decisions</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">&quot;Look at @.vibe/development-plan-feature-auth.md to see our authentication approach&quot;</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># Commit with context</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">git</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> commit</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -m</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;add JWT validation</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">Based on security analysis in development-plan-feature-auth.md,</span></span>
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">implemented token-based auth with 24h expiry.&quot;</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># AI can then read the commit and reference the plan file for full context</span></span></code></pre></div><h2 id="real-world-example" tabindex="-1">Real-World Example <a class="header-anchor" href="#real-world-example" aria-label="Permalink to &quot;Real-World Example&quot;">​</a></h2><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># Start new feature</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">git</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> checkout</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -b</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> feature-payment</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># AI automatically:</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># 1. Creates development-plan-feature-payment.md for this branch&#39;s context</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># 2. Can reference existing .vibe/docs/architecture.md via workflow variables</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># 3. Follows your .kiro/rules/ coding standards</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># 4. Maintains separate conversation context for this branch</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># Document decisions in plan file during development</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># Plan file captures: requirements analysis, architectural decisions, implementation notes</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># Later, commit with reference:</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">git</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> commit</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -m</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;implement payment processing</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">See development-plan-feature-payment.md for security considerations</span></span>
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">and integration approach with existing user system.&quot;</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># Weeks later, you or your AI can explicitly reference the plan:</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">&quot;Check @.vibe/development-plan-feature-payment.md to understand the payment flow&quot;</span></span></code></pre></div><h2 id="why-this-matters" tabindex="-1">Why This Matters <a class="header-anchor" href="#why-this-matters" aria-label="Permalink to &quot;Why This Matters&quot;">​</a></h2><p>Most AI tools treat each conversation as isolated. Responsible Vibe provides <strong>structured documentation and explicit reference systems</strong> for ongoing engineering:</p><ul><li><strong>Explicit reference context</strong> through plan files and commits</li><li><strong>Structured documentation</strong> that grows with your project (<code>.vibe/docs/</code>)</li><li><strong>Branch-aware development</strong> with separate conversation contexts</li><li><strong>Consistent standards</strong> through rule files integration</li></ul><p>The key difference: <strong>You control when and how context is referenced</strong>, rather than relying on automatic memory that may or may not work.</p><p>This is software engineering, not just code generation.</p><hr><p><strong>Next</strong>: <a href="./long-term-memory.html">Long-Term Memory</a> – Deep dive into persistence and context management</p>`,61)])])}const u=s(t,[["render",o]]);export{g as __pageData,u as default};
