DocProcessor/ARCHITECTURE.html at master · HelixDevelopment/DocProcessor · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
  <meta charset="utf-8" />
  <meta name="generator" content="pandoc" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
  <title>ARCHITECTURE</title>
  <style>

html {
color: #1a1a1a;
background-color: #fdfdfd;
}
body {
margin: 0 auto;
max-width: 36em;
padding-left: 50px;
padding-right: 50px;
padding-top: 50px;
padding-bottom: 50px;
hyphens: auto;
overflow-wrap: break-word;
text-rendering: optimizeLegibility;
font-kerning: normal;
}
@media (max-width: 600px) {
body {
font-size: 0.9em;
padding: 12px;
}
h1 {
font-size: 1.8em;
}
}
@media print {
html {
background-color: white;
}
body {
background-color: transparent;
color: black;
font-size: 12pt;
}
p, h2, h3 {
orphans: 3;
widows: 3;
}
h2, h3, h4 {
page-break-after: avoid;
}
}
p {
margin: 1em 0;
}
a {
color: #1a1a1a;
}
a:visited {
color: #1a1a1a;
}
img {
max-width: 100%;
}
svg {
height: auto;
max-width: 100%;
}
h1, h2, h3, h4, h5, h6 {
margin-top: 1.4em;
}
h5, h6 {
font-size: 1em;
font-style: italic;
}
h6 {
font-weight: normal;
}
ol, ul {
padding-left: 1.7em;
margin-top: 1em;
}
li > ol, li > ul {
margin-top: 0;
}
blockquote {
margin: 1em 0 1em 1.7em;
padding-left: 1em;
border-left: 2px solid #e6e6e6;
color: #606060;
}
code {
font-family: Menlo, Monaco, Consolas, 'Lucida Console', monospace;
font-size: 85%;
margin: 0;
hyphens: manual;
}
pre {
margin: 1em 0;
overflow: auto;
}
pre code {
padding: 0;
overflow: visible;
overflow-wrap: normal;
}
.sourceCode {
background-color: transparent;
overflow: visible;
}
hr {
border: none;
border-top: 1px solid #1a1a1a;
height: 1px;
margin: 1em 0;
}
table {
margin: 1em 0;
border-collapse: collapse;
width: 100%;
overflow-x: auto;
display: block;
font-variant-numeric: lining-nums tabular-nums;
}
table caption {
margin-bottom: 0.75em;
}
tbody {
margin-top: 0.5em;
border-top: 1px solid #1a1a1a;
border-bottom: 1px solid #1a1a1a;
}
th {
border-top: 1px solid #1a1a1a;
padding: 0.25em 0.5em 0.25em 0.5em;
}
td {
padding: 0.125em 0.5em 0.25em 0.5em;
}
header {
margin-bottom: 4em;
text-align: center;
}
#TOC li {
list-style: none;
}
#TOC ul {
padding-left: 1.3em;
}
#TOC > ul {
padding-left: 0;
}
#TOC a:not(:hover) {
text-decoration: none;
}
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
div.columns{display: flex; gap: min(4vw, 1.5em);}
div.column{flex: auto; overflow-x: auto;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}

ul.task-list[class]{list-style: none;}
ul.task-list li input[type="checkbox"] {
font-size: inherit;
width: 0.8em;
margin: 0 0.8em 0.2em -1.6em;
vertical-align: middle;
}
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
</style>
</head>
<body>
<header id="title-block-header">
<h1 class="title">ARCHITECTURE</h1>
</header>
<h1 id="architecture">Architecture</h1>
<h2 id="component-diagram">Component Diagram</h2>
<pre class="mermaid"><code>graph TB
    subgraph DocProcessor
        Loader[pkg/loader]
        Feature[pkg/feature]
        Coverage[pkg/coverage]
        DocGraph[pkg/docgraph]
        LLM[pkg/llm]
        Config[pkg/config]
    end

    Docs[(Project Docs)] --&gt; Loader
    Loader --&gt; Feature
    Feature --&gt; Coverage
    Feature --&gt; DocGraph
    LLM --&gt; Feature
    Config --&gt; Loader
    Config --&gt; Feature</code></pre>
<h2 id="sequence-diagram">Sequence Diagram</h2>
<pre class="mermaid"><code>sequenceDiagram
    participant Caller
    participant Loader
    participant Builder as FeatureMapBuilder
    participant LLM as LLMAgent
    participant Tracker as CoverageTracker

    Caller-&gt;&gt;Loader: LoadDir(ctx, path)
    Loader--&gt;&gt;Caller: []Document

    Caller-&gt;&gt;Builder: BuildFromDocs(ctx, docs)
    Builder--&gt;&gt;Caller: *FeatureMap

    Caller-&gt;&gt;Builder: Enrich(ctx, fm, agent)
    Builder-&gt;&gt;LLM: InferScreens(ctx, features)
    LLM--&gt;&gt;Builder: []ExpectedScreen
    Builder-&gt;&gt;LLM: GenerateTestSteps(ctx, feature)
    LLM--&gt;&gt;Builder: []TestStep
    Builder--&gt;&gt;Caller: nil (enriched in-place)

    Caller-&gt;&gt;Tracker: RegisterFeature(f, platforms)
    Caller-&gt;&gt;Tracker: MarkVerified(id, platform, evidence)
    Caller-&gt;&gt;Tracker: Coverage()
    Tracker--&gt;&gt;Caller: CoverageReport</code></pre>
<h2 id="class-diagram">Class Diagram</h2>
<pre class="mermaid"><code>classDiagram
    class Loader {
        &lt;&lt;interface&gt;&gt;
        +LoadDir(ctx, path) []Document, error
        +LoadFile(ctx, path) Document, error
        +SupportedFormats() []string
    }

    class Document {
        +Path string
        +Format string
        +Title string
        +Content string
        +Sections []Section
        +Links []string
        +ModifiedAt time.Time
    }

    class FeatureMapBuilder {
        &lt;&lt;interface&gt;&gt;
        +BuildFromDocs(ctx, docs) *FeatureMap, error
        +Enrich(ctx, fm, agent) error
        +Merge(maps...) *FeatureMap
    }

    class FeatureMap {
        +Features []Feature
        +Screens []ExpectedScreen
        +Workflows []Workflow
        +Categories map
        +PlatformMatrix map
        +DocGraph *DocGraph
        +AddFeature(f)
        +FeatureByID(id) *Feature
    }

    class CoverageTracker {
        &lt;&lt;interface&gt;&gt;
        +MarkVerified(id, platform, evidence)
        +MarkFailed(id, platform, issue)
        +MarkSkipped(id, platform, reason)
        +Coverage() CoverageReport
        +CoverageByPlatform(platform) float64
        +CoverageByCategory(category) float64
        +Unverified() []Feature
        +Export() CoverageSnapshot
    }

    class LLMAgent {
        &lt;&lt;interface&gt;&gt;
        +Summarize(ctx, text) string, error
        +ExtractFeatures(ctx, text) []RawFeature, error
        +ClassifyFeature(ctx, feature) FeatureCategory, error
        +InferScreens(ctx, features) []ExpectedScreen, error
        +GenerateTestSteps(ctx, feature) []TestStep, error
    }

    Loader --&gt; Document
    FeatureMapBuilder --&gt; FeatureMap
    FeatureMapBuilder --&gt; LLMAgent
    FeatureMap --&gt; DocGraph
    CoverageTracker --&gt; Feature</code></pre>
<h2 id="state-diagram">State Diagram</h2>
<pre class="mermaid"><code>stateDiagram-v2
    [*] --&gt; Unverified: RegisterFeature

    Unverified --&gt; Verified: MarkVerified
    Unverified --&gt; Failed: MarkFailed
    Unverified --&gt; Skipped: MarkSkipped

    Failed --&gt; Verified: MarkVerified (retry)
    Skipped --&gt; Verified: MarkVerified (retry)
    Verified --&gt; Failed: MarkFailed (regression)</code></pre>
<h2 id="flowchart">Flowchart</h2>
<pre class="mermaid"><code>flowchart TD
    A[Start] --&gt; B{Load Documents}
    B --&gt;|Success| C[Parse Markdown/YAML/HTML]
    B --&gt;|Error| Z[Return Error]
    C --&gt; D[Extract Features Heuristic]
    D --&gt; E{LLM Available?}
    E --&gt;|Yes| F[LLM Extract Features]
    E --&gt;|No| G[Use Heuristic Results]
    F --&gt; H[Build FeatureMap]
    G --&gt; H
    H --&gt; I[Enrich with LLM]
    I --&gt; J[Register in CoverageTracker]
    J --&gt; K[Execute Verification]
    K --&gt; L{Feature Status}
    L --&gt;|Pass| M[MarkVerified]
    L --&gt;|Fail| N[MarkFailed]
    L --&gt;|Skip| O[MarkSkipped]
    M --&gt; P[Generate Report]
    N --&gt; P
    O --&gt; P
    P --&gt; Q[End]</code></pre>
<h2 id="package-dependencies">Package Dependencies</h2>
<pre><code>config (no deps)
docgraph (no deps)
llm (no deps)
loader (yaml.v3)
feature (loader, llm, docgraph)
coverage (no internal deps)</code></pre>
<h2 id="thread-safety">Thread Safety</h2>
<p>The <code>CoverageTracker</code> implementation uses
<code>sync.RWMutex</code> for concurrent access:</p>
<ul>
<li>Read operations (<code>Coverage()</code>,
<code>CoverageByPlatform()</code>, <code>Unverified()</code>) use
<code>RLock()</code></li>
<li>Write operations (<code>MarkVerified()</code>,
<code>MarkFailed()</code>, <code>MarkSkipped()</code>) use
<code>Lock()</code></li>
</ul>
<p>The <code>DocGraph</code> also uses <code>sync.RWMutex</code> for
concurrent node/edge operations.</p>
<h2 id="design-decisions">Design Decisions</h2>
<ol type="1">
<li><strong>LLMAgent is injected</strong> -- No module-level dependency
on LLMOrchestrator</li>
<li><strong>Feature IDs are deterministic</strong> -- Same feature name
produces same ID across runs</li>
<li><strong>Heuristic fallback</strong> -- Feature extraction works
without an LLM agent</li>
<li><strong>Prompt templates versioned</strong> -- Trackable changes to
LLM prompts</li>
<li><strong>MaxFileSize limit</strong> -- 10 MB cap prevents OOM on
large binary files</li>
</ol>
</body>
</html>