401 lines
25 KiB
HTML
401 lines
25 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="navy" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Traces Quick Reference - JellyTau Documentation</title>
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
<meta name="description" content="Requirements, traceability, and architecture for the JellyTau Jellyfin client.">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#ffffff">
|
|
|
|
<link rel="icon" href="favicon.svg">
|
|
<link rel="shortcut icon" href="favicon.png">
|
|
<link rel="stylesheet" href="css/variables.css">
|
|
<link rel="stylesheet" href="css/general.css">
|
|
<link rel="stylesheet" href="css/chrome.css">
|
|
<link rel="stylesheet" href="css/print.css" media="print">
|
|
|
|
<!-- Fonts -->
|
|
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
|
|
<link rel="stylesheet" href="fonts/fonts.css">
|
|
|
|
<!-- Highlight.js Stylesheets -->
|
|
<link rel="stylesheet" href="highlight.css">
|
|
<link rel="stylesheet" href="tomorrow-night.css">
|
|
<link rel="stylesheet" href="ayu-highlight.css">
|
|
|
|
<!-- Custom theme stylesheets -->
|
|
|
|
</head>
|
|
<body class="sidebar-visible no-js">
|
|
<div id="body-container">
|
|
<!-- Provide site root to javascript -->
|
|
<script>
|
|
var path_to_root = "";
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "navy";
|
|
</script>
|
|
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|
<script>
|
|
try {
|
|
var theme = localStorage.getItem('mdbook-theme');
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
|
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
|
}
|
|
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
|
}
|
|
} catch (e) { }
|
|
</script>
|
|
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
|
<script>
|
|
var theme;
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|
var html = document.querySelector('html');
|
|
html.classList.remove('navy')
|
|
html.classList.add(theme);
|
|
var body = document.querySelector('body');
|
|
body.classList.remove('no-js')
|
|
body.classList.add('js');
|
|
</script>
|
|
|
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script>
|
|
var body = document.querySelector('body');
|
|
var sidebar = null;
|
|
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
|
if (document.body.clientWidth >= 1080) {
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|
sidebar = sidebar || 'visible';
|
|
} else {
|
|
sidebar = 'hidden';
|
|
}
|
|
sidebar_toggle.checked = sidebar === 'visible';
|
|
body.classList.remove('sidebar-visible');
|
|
body.classList.add("sidebar-" + sidebar);
|
|
</script>
|
|
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|
<div class="sidebar-scrollbox">
|
|
<ol class="chapter"><li class="chapter-item expanded affix "><a href="index.html">Introduction</a></li><li class="chapter-item expanded affix "><li class="part-title">Requirements & Traceability</li><li class="chapter-item expanded "><a href="requirements.html"><strong aria-hidden="true">1.</strong> Requirements Specification</a></li><li class="chapter-item expanded "><a href="traceability.html"><strong aria-hidden="true">2.</strong> Traceability Matrix</a></li><li class="chapter-item expanded "><a href="traceability-ci.html"><strong aria-hidden="true">3.</strong> Traceability CI</a></li><li class="chapter-item expanded "><a href="traces-quick-ref.html" class="active"><strong aria-hidden="true">4.</strong> Traces Quick Reference</a></li><li class="chapter-item expanded affix "><li class="part-title">Architecture</li><li class="chapter-item expanded "><a href="architecture/index.html"><strong aria-hidden="true">5.</strong> Overview</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="architecture/01-rust-backend.html"><strong aria-hidden="true">5.1.</strong> Rust Backend</a></li><li class="chapter-item "><a href="architecture/02-svelte-frontend.html"><strong aria-hidden="true">5.2.</strong> Svelte Frontend</a></li><li class="chapter-item "><a href="architecture/03-data-flow.html"><strong aria-hidden="true">5.3.</strong> Data Flow</a></li><li class="chapter-item "><a href="architecture/04-type-sync-and-threading.html"><strong aria-hidden="true">5.4.</strong> Type Sync & Threading</a></li><li class="chapter-item "><a href="architecture/05-platform-backends.html"><strong aria-hidden="true">5.5.</strong> Platform Backends</a></li><li class="chapter-item "><a href="architecture/06-downloads-and-offline.html"><strong aria-hidden="true">5.6.</strong> Downloads & Offline</a></li><li class="chapter-item "><a href="architecture/07-connectivity.html"><strong aria-hidden="true">5.7.</strong> Connectivity</a></li><li class="chapter-item "><a href="architecture/08-database-design.html"><strong aria-hidden="true">5.8.</strong> Database Design</a></li><li class="chapter-item "><a href="architecture/09-security.html"><strong aria-hidden="true">5.9.</strong> Security</a></li></ol></li><li class="chapter-item expanded "><li class="part-title">UX</li><li class="chapter-item expanded "><a href="ux-flows.html"><strong aria-hidden="true">6.</strong> UX Flows</a></li><li class="chapter-item expanded affix "><li class="part-title">Specs — Pending Work</li><li class="chapter-item expanded "><a href="specs/index.html"><strong aria-hidden="true">7.</strong> Specs Index</a></li><li class="chapter-item expanded "><a href="specs/SPEC-TEMPLATE.html"><strong aria-hidden="true">8.</strong> Spec Template</a></li><li class="chapter-item expanded "><a href="specs/SPEC-REVIEW-CHECKLIST.html"><strong aria-hidden="true">9.</strong> Spec Review Checklist</a></li><li class="chapter-item expanded "><a href="specs/playback-backend-unification.html"><strong aria-hidden="true">10.</strong> Playback Backend Unification</a></li><li class="chapter-item expanded "><a href="specs/linux-native-video-spike.html"><strong aria-hidden="true">11.</strong> Linux Native Video Spike</a></li><li class="chapter-item expanded "><a href="specs/backend-owned-stream-selection.html"><strong aria-hidden="true">12.</strong> Backend-Owned Stream Selection</a></li><li class="chapter-item expanded "><a href="specs/player-facade-enforcement.html"><strong aria-hidden="true">13.</strong> Player Facade Enforcement</a></li><li class="chapter-item expanded "><a href="specs/windows-native-audio-backend.html"><strong aria-hidden="true">14.</strong> Windows Native Audio Backend</a></li><li class="chapter-item expanded "><a href="specs/libmpv2-migration.html"><strong aria-hidden="true">15.</strong> libmpv2 Migration</a></li><li class="chapter-item expanded "><a href="specs/read-through-media-cache.html"><strong aria-hidden="true">16.</strong> Read-Through Media Cache</a></li><li class="chapter-item expanded "><a href="specs/scoped-search.html"><strong aria-hidden="true">17.</strong> Scoped Search</a></li><li class="chapter-item expanded "><a href="specs/scoped-search-boundary.html"><strong aria-hidden="true">18.</strong> Scoped Search Boundary</a></li><li class="chapter-item expanded "><a href="specs/scoped-search-boundary-implementation.html"><strong aria-hidden="true">19.</strong> Scoped Search Boundary — Implementation</a></li><li class="chapter-item expanded "><a href="specs/frontend-domain-model.html"><strong aria-hidden="true">20.</strong> Frontend Domain Model</a></li><li class="chapter-item expanded "><a href="specs/build-provenance.html"><strong aria-hidden="true">21.</strong> Build Provenance</a></li><li class="chapter-item expanded affix "><li class="part-title">Build & Release</li><li class="chapter-item expanded "><a href="build/build-release.html"><strong aria-hidden="true">22.</strong> Build & Release</a></li><li class="chapter-item expanded "><a href="release-checklist.html"><strong aria-hidden="true">23.</strong> Release Checklist</a></li><li class="chapter-item expanded "><a href="build/build-desktop-packages.html"><strong aria-hidden="true">24.</strong> Desktop Packaging</a></li><li class="chapter-item expanded "><a href="build/build-windows.html"><strong aria-hidden="true">25.</strong> Windows Build</a></li><li class="chapter-item expanded "><a href="defect-windows.html"><strong aria-hidden="true">26.</strong> Defect Windows</a></li><li class="chapter-item expanded "><a href="build/docker.html"><strong aria-hidden="true">27.</strong> Docker</a></li><li class="chapter-item expanded "><a href="build/build-builder-image.html"><strong aria-hidden="true">28.</strong> Builder Image</a></li><li class="chapter-item expanded affix "><li class="spacer"></li><li class="chapter-item expanded affix "><a href="api-redirect.html">Rust API Reference (rustdoc)</a></li></ol>
|
|
</div>
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
|
<div class="sidebar-resize-indicator"></div>
|
|
</div>
|
|
</nav>
|
|
|
|
<!-- Track and set sidebar scroll position -->
|
|
<script>
|
|
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
|
|
sidebarScrollbox.addEventListener('click', function(e) {
|
|
if (e.target.tagName === 'A') {
|
|
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
|
|
}
|
|
}, { passive: true });
|
|
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
|
|
sessionStorage.removeItem('sidebar-scroll');
|
|
if (sidebarScrollTop) {
|
|
// preserve sidebar scroll position when navigating via links within sidebar
|
|
sidebarScrollbox.scrollTop = sidebarScrollTop;
|
|
} else {
|
|
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
|
|
var activeSection = document.querySelector('#sidebar .active');
|
|
if (activeSection) {
|
|
activeSection.scrollIntoView({ block: 'center' });
|
|
}
|
|
}
|
|
</script>
|
|
|
|
<div id="page-wrapper" class="page-wrapper">
|
|
|
|
<div class="page">
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|
<div id="menu-bar" class="menu-bar sticky">
|
|
<div class="left-buttons">
|
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|
<i class="fa fa-bars"></i>
|
|
</label>
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
|
<i class="fa fa-paint-brush"></i>
|
|
</button>
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
|
</ul>
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
|
<i class="fa fa-search"></i>
|
|
</button>
|
|
</div>
|
|
|
|
<h1 class="menu-title">JellyTau Documentation</h1>
|
|
|
|
<div class="right-buttons">
|
|
<a href="print.html" title="Print this book" aria-label="Print this book">
|
|
<i id="print-button" class="fa fa-print"></i>
|
|
</a>
|
|
<a href="https://gitea.tourolle.paris/dtourolle/jellytau" title="Git repository" aria-label="Git repository">
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
|
</a>
|
|
<a href="https://gitea.tourolle.paris/dtourolle/jellytau/_edit/master/docs/../docs/traces-quick-ref.md" title="Suggest an edit" aria-label="Suggest an edit">
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-wrapper" class="hidden">
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
|
</form>
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
|
<ul id="searchresults">
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
|
<script>
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
|
});
|
|
</script>
|
|
|
|
<div id="content" class="content">
|
|
<main>
|
|
<h1 id="traces-quick-reference-guide"><a class="header" href="#traces-quick-reference-guide">TRACES Quick Reference Guide</a></h1>
|
|
<h2 id="what-are-traces"><a class="header" href="#what-are-traces">What are TRACES?</a></h2>
|
|
<p>TRACES are requirement identifiers embedded in code comments to track which requirements are implemented where.</p>
|
|
<p>Format: <code>// TRACES: UR-001, UR-002 | DR-003</code></p>
|
|
<h2 id="quick-examples"><a class="header" href="#quick-examples">Quick Examples</a></h2>
|
|
<h3 id="typescript"><a class="header" href="#typescript">TypeScript</a></h3>
|
|
<pre><code class="language-typescript">// TRACES: UR-005, UR-026 | DR-029
|
|
export function handlePlayback() { }
|
|
|
|
/**
|
|
* Resume playback from saved position
|
|
* TRACES: UR-019 | DR-022
|
|
*/
|
|
export async function resumePlayback(itemId: string) { }
|
|
</code></pre>
|
|
<h3 id="svelte"><a class="header" href="#svelte">Svelte</a></h3>
|
|
<pre><code class="language-svelte"><!-- TRACES: UR-007, UR-008 | DR-007 -->
|
|
<script>
|
|
export let items = [];
|
|
</script>
|
|
</code></pre>
|
|
<h3 id="rust"><a class="header" href="#rust">Rust</a></h3>
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
|
</span><span class="boring">fn main() {
|
|
</span>/// TRACES: UR-005 | DR-001
|
|
pub enum PlayerState { ... }
|
|
|
|
#[test]
|
|
fn test_queue_next() {
|
|
// TRACES: UR-005 | DR-005 | UT-003
|
|
}
|
|
<span class="boring">}</span></code></pre></pre>
|
|
<h2 id="requirement-types"><a class="header" href="#requirement-types">Requirement Types</a></h2>
|
|
<div class="table-wrapper"><table><thead><tr><th>Type</th><th>Meaning</th><th>Example</th></tr></thead><tbody>
|
|
<tr><td><strong>UR</strong></td><td>User Requirement</td><td>UR-005: Control media playback</td></tr>
|
|
<tr><td><strong>IR</strong></td><td>Integration Requirement</td><td>IR-003: LibMPV integration</td></tr>
|
|
<tr><td><strong>DR</strong></td><td>Development Requirement</td><td>DR-001: Player state machine</td></tr>
|
|
<tr><td><strong>JA</strong></td><td>Jellyfin API Requirement</td><td>JA-007: Get playback info</td></tr>
|
|
<tr><td><strong>UT</strong></td><td>Unit Test</td><td>UT-001: Player state transitions</td></tr>
|
|
<tr><td><strong>IT</strong></td><td>Integration Test</td><td>IT-003: Audio playback via libmpv</td></tr>
|
|
</tbody></table>
|
|
</div>
|
|
<h2 id="where-to-find-requirements"><a class="header" href="#where-to-find-requirements">Where to Find Requirements</a></h2>
|
|
<ol>
|
|
<li><strong>User Requirements (UR):</strong> <a href="requirements.html#1-user-requirements">requirements.md</a></li>
|
|
<li><strong>Integration Requirements (IR):</strong> <a href="requirements.html#21-integration-requirements">requirements.md</a></li>
|
|
<li><strong>Development Requirements (DR):</strong> <a href="requirements.html#23-development-requirements">requirements.md</a></li>
|
|
<li><strong>Jellyfin API (JA):</strong> <a href="requirements.html#22-jellyfin-api-requirements">requirements.md</a></li>
|
|
</ol>
|
|
<h2 id="how-to-add-traces"><a class="header" href="#how-to-add-traces">How to Add TRACES</a></h2>
|
|
<h3 id="step-1-find-the-requirement"><a class="header" href="#step-1-find-the-requirement">Step 1: Find the Requirement</a></h3>
|
|
<p>Look up the requirement in README.md or the traceability matrix.</p>
|
|
<p>Example: <code>UR-005: Control media playback (pause, play, skip, scrub)</code></p>
|
|
<h3 id="step-2-add-comment"><a class="header" href="#step-2-add-comment">Step 2: Add Comment</a></h3>
|
|
<p>Add TRACES comment at the top of the function/type/module:</p>
|
|
<pre><code class="language-typescript">// TRACES: UR-005
|
|
export async function playMedia(itemId: string) {
|
|
// Implementation
|
|
}
|
|
</code></pre>
|
|
<h3 id="step-3-run-extraction"><a class="header" href="#step-3-run-extraction">Step 3: Run Extraction</a></h3>
|
|
<p>Verify the trace is captured:</p>
|
|
<pre><code class="language-bash">bun run traces:json | jq '.requirements | keys | grep "UR-005"'
|
|
</code></pre>
|
|
<h2 id="common-patterns"><a class="header" href="#common-patterns">Common Patterns</a></h2>
|
|
<h3 id="single-requirement"><a class="header" href="#single-requirement">Single Requirement</a></h3>
|
|
<pre><code class="language-typescript">// TRACES: UR-005
|
|
function handlePlay() { }
|
|
</code></pre>
|
|
<h3 id="multiple-requirements-same-type"><a class="header" href="#multiple-requirements-same-type">Multiple Requirements, Same Type</a></h3>
|
|
<pre><code class="language-typescript">// TRACES: UR-005, UR-026, UR-019
|
|
function handlePlaybackState() { }
|
|
</code></pre>
|
|
<h3 id="multiple-types"><a class="header" href="#multiple-types">Multiple Types</a></h3>
|
|
<pre><code class="language-typescript">// TRACES: UR-005, UR-026 | DR-029
|
|
function autoplayNextEpisode() { }
|
|
</code></pre>
|
|
<h3 id="test-coverage"><a class="header" href="#test-coverage">Test Coverage</a></h3>
|
|
<pre><code class="language-typescript">// TRACES: UR-005 | UT-001
|
|
#[test]
|
|
fn test_player_state_transition() { }
|
|
</code></pre>
|
|
<h3 id="modulesfiles"><a class="header" href="#modulesfiles">Modules/Files</a></h3>
|
|
<pre><code class="language-typescript">/**
|
|
* Player event handling
|
|
* TRACES: UR-005, UR-019, UR-023 | DR-001, DR-028
|
|
*/
|
|
</code></pre>
|
|
<h2 id="validation"><a class="header" href="#validation">Validation</a></h2>
|
|
<h3 id="check-your-changes"><a class="header" href="#check-your-changes">Check Your Changes</a></h3>
|
|
<pre><code class="language-bash"># View current coverage
|
|
bun run traces:json | jq '.byType'
|
|
|
|
# Generate full report
|
|
bun run traces:markdown
|
|
|
|
# Check specific requirement
|
|
bun run traces:json | jq '.requirements."UR-005"'
|
|
</code></pre>
|
|
<h3 id="before-committing"><a class="header" href="#before-committing">Before Committing</a></h3>
|
|
<ol>
|
|
<li>Ensure all new code has TRACES</li>
|
|
<li>Format is correct: <code>// TRACES: ...</code></li>
|
|
<li>Requirements exist in <code>docs/requirements.md</code> — <code>bun run traces:validate</code></li>
|
|
<li>No typos in requirement IDs (same command catches them)</li>
|
|
</ol>
|
|
<h2 id="cicd-validation"><a class="header" href="#cicd-validation">CI/CD Validation</a></h2>
|
|
<p>The workflow automatically checks:</p>
|
|
<ul>
|
|
<li>✅ Coverage stays >= 88% (a ratchet — raise it, never lower it)</li>
|
|
<li>✅ Every traced ID is defined in <code>docs/requirements.md</code></li>
|
|
<li>✅ New files have TRACES</li>
|
|
<li>✅ JSON format is valid</li>
|
|
<li>✅ Reports are generated</li>
|
|
</ul>
|
|
<p>See <a href="traceability-ci.html">traceability-ci.md</a> for details.</p>
|
|
<h2 id="tips--tricks"><a class="header" href="#tips--tricks">Tips & Tricks</a></h2>
|
|
<h3 id="find-related-code"><a class="header" href="#find-related-code">Find Related Code</a></h3>
|
|
<pre><code class="language-bash"># Find all code tracing to UR-005
|
|
bun run traces:json | jq '.requirements."UR-005"'
|
|
|
|
# List all tests
|
|
bun run traces:json | jq '.requirements | keys | map(select(startswith("UT")))'
|
|
</code></pre>
|
|
<h3 id="update-your-editor"><a class="header" href="#update-your-editor">Update Your Editor</a></h3>
|
|
<p><strong>VS Code:</strong></p>
|
|
<pre><code class="language-json">{
|
|
"editor.wordBasedSuggestions": false,
|
|
"editor.suggest.custom": [
|
|
{
|
|
"name": "TRACES Format",
|
|
"insertText": "// TRACES: $1",
|
|
"insertTextRules": "InsertAsSnippet"
|
|
}
|
|
]
|
|
}
|
|
</code></pre>
|
|
<h3 id="find-untraced-code"><a class="header" href="#find-untraced-code">Find Untraced Code</a></h3>
|
|
<pre><code class="language-bash"># Files modified without TRACES
|
|
git diff --name-only | xargs grep -L "TRACES:" | head -10
|
|
</code></pre>
|
|
<h2 id="faq"><a class="header" href="#faq">FAQ</a></h2>
|
|
<p><strong>Q: Do I need TRACES on every function?</strong>
|
|
A: Only for code that implements requirements. Internal helpers don't need TRACES.</p>
|
|
<p><strong>Q: Can I use TRACES on multiple related functions?</strong>
|
|
A: Yes! Add at the file/module level or on individual functions.</p>
|
|
<p><strong>Q: What if code doesn't relate to any requirement?</strong>
|
|
A: Leave it untraced. TRACES are for requirement-driven development.</p>
|
|
<p><strong>Q: How often should I regenerate reports?</strong>
|
|
A: Automatically on push (CI/CD). Manually after changes: <code>bun run traces:markdown</code></p>
|
|
<p><strong>Q: Can I trace to requirements that aren't implemented yet?</strong>
|
|
A: Yes! TRACES show your implementation plan.</p>
|
|
<h2 id="see-also"><a class="header" href="#see-also">See Also</a></h2>
|
|
<ul>
|
|
<li><a href="traceability.html">Full Traceability Matrix</a></li>
|
|
<li><a href="traceability-ci.html">CI/CD Pipeline Guide</a></li>
|
|
<li><a href="requirements.html">Requirements Specification</a></li>
|
|
<li><a href="../scripts/README.html#extract-tracests">Extraction Script</a></li>
|
|
</ul>
|
|
<hr />
|
|
<p><strong>Quick Start:</strong></p>
|
|
<ol>
|
|
<li>Add <code>// TRACES: UR-XXX</code> to new code</li>
|
|
<li>Run <code>bun run traces:markdown</code></li>
|
|
<li>Check <code>docs/traceability.md</code></li>
|
|
<li>Submit PR - workflow validates automatically!</li>
|
|
</ol>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="traceability-ci.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="architecture/index.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
<div style="clear: both"></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
|
<a rel="prev" href="traceability-ci.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="architecture/index.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
window.playground_copyable = true;
|
|
</script>
|
|
|
|
|
|
<script src="elasticlunr.min.js"></script>
|
|
<script src="mark.min.js"></script>
|
|
<script src="searcher.js"></script>
|
|
|
|
<script src="clipboard.min.js"></script>
|
|
<script src="highlight.js"></script>
|
|
<script src="book.js"></script>
|
|
|
|
<!-- Custom JS scripts -->
|
|
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|