Eng-Docs/orcta-workflow.html at main · Orctatech-Engineering-Team/Eng-Docs · 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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Orcta Development Workflow</title>
    <link rel="preconnect" href="https://fonts.googleapis.com">
    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
    <link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&display=swap" rel="stylesheet">
    <style>
        * {
            margin: 0;
            padding: 0;
            box-sizing: border-box;
        }

        body {
            font-family: 'Inter', -apple-system, BlinkMacSystemFont, sans-serif;
            background: #fafafa;
            padding: 48px 24px;
            color: #1a1a1a;
            line-height: 1.6;
            -webkit-font-smoothing: antialiased;
            -moz-osx-font-smoothing: grayscale;
        }

        .container {
            max-width: 920px;
            margin: 0 auto;
            background: white;
            border-radius: 8px;
            box-shadow: 0 1px 3px rgba(0,0,0,0.06), 0 1px 2px rgba(0,0,0,0.08);
            padding: 64px 72px;
        }

        .header {
            border-bottom: 1px solid #e8e8e8;
            padding-bottom: 32px;
            margin-bottom: 48px;
        }

        .header h1 {
            font-size: 32px;
            font-weight: 600;
            color: #1a1a1a;
            letter-spacing: -0.02em;
            margin-bottom: 12px;
        }

        .header .subtitle {
            font-size: 16px;
            color: #6b6b6b;
            font-weight: 400;
            letter-spacing: -0.01em;
        }

        .section {
            margin-bottom: 56px;
        }

        .section:last-child {
            margin-bottom: 0;
        }

        .section-title {
            font-size: 20px;
            font-weight: 600;
            color: #1a1a1a;
            margin-bottom: 24px;
            letter-spacing: -0.02em;
        }

        .workflow-step {
            display: grid;
            grid-template-columns: 40px 1fr;
            gap: 20px;
            margin-bottom: 28px;
            padding-bottom: 28px;
            border-bottom: 1px solid #f0f0f0;
        }

        .workflow-step:last-child {
            border-bottom: none;
            margin-bottom: 0;
            padding-bottom: 0;
        }

        .step-number {
            width: 40px;
            height: 40px;
            border-radius: 50%;
            background: #f5f5f5;
            display: flex;
            align-items: center;
            justify-content: center;
            font-size: 15px;
            font-weight: 600;
            color: #4a4a4a;
            flex-shrink: 0;
        }

        .step-content h3 {
            font-size: 17px;
            font-weight: 600;
            color: #1a1a1a;
            margin-bottom: 8px;
            letter-spacing: -0.01em;
        }

        .step-content p {
            font-size: 15px;
            color: #5a5a5a;
            line-height: 1.6;
            margin-bottom: 12px;
        }

        .step-details {
            font-size: 14px;
            color: #8a8a8a;
            line-height: 1.5;
            padding-left: 16px;
            border-left: 2px solid #f0f0f0;
            margin-top: 12px;
        }

        .principle-grid {
            display: grid;
            grid-template-columns: repeat(2, 1fr);
            gap: 20px;
            margin-top: 24px;
        }

        .principle-card {
            padding: 24px;
            background: #fafafa;
            border-radius: 6px;
            border: 1px solid #f0f0f0;
        }

        .principle-card h3 {
            font-size: 15px;
            font-weight: 600;
            color: #1a1a1a;
            margin-bottom: 8px;
            letter-spacing: -0.01em;
        }

        .principle-card p {
            font-size: 14px;
            color: #6b6b6b;
            line-height: 1.5;
        }

        .environment-flow {
            display: flex;
            align-items: center;
            justify-content: space-between;
            margin-top: 24px;
            padding: 28px;
            background: #fafafa;
            border-radius: 6px;
            border: 1px solid #f0f0f0;
        }

        .env-item {
            text-align: center;
            flex: 1;
        }

        .env-name {
            font-size: 15px;
            font-weight: 600;
            color: #1a1a1a;
            margin-bottom: 6px;
        }

        .env-description {
            font-size: 13px;
            color: #8a8a8a;
            line-height: 1.4;
        }

        .arrow {
            color: #d0d0d0;
            font-size: 20px;
            margin: 0 16px;
        }

        .checklist {
            list-style: none;
            margin-top: 16px;
        }

        .checklist li {
            font-size: 14px;
            color: #5a5a5a;
            padding: 10px 0;
            padding-left: 28px;
            position: relative;
            line-height: 1.5;
        }

        .checklist li::before {
            content: '';
            position: absolute;
            left: 0;
            top: 16px;
            width: 16px;
            height: 16px;
            border: 1.5px solid #d0d0d0;
            border-radius: 3px;
        }

        .code-convention {
            display: flex;
            align-items: baseline;
            padding: 10px 0;
            font-size: 14px;
            border-bottom: 1px solid #f5f5f5;
        }

        .code-convention:last-child {
            border-bottom: none;
        }

        .convention-label {
            font-weight: 500;
            color: #4a4a4a;
            min-width: 140px;
        }

        .convention-value {
            font-family: 'SF Mono', Monaco, 'Courier New', monospace;
            font-size: 13px;
            color: #8a8a8a;
            background: #f5f5f5;
            padding: 2px 8px;
            border-radius: 3px;
        }

        .reference-section {
            margin-top: 48px;
            padding-top: 32px;
            border-top: 1px solid #e8e8e8;
        }

        .reference-link {
            display: inline-block;
            font-size: 14px;
            color: #5a5a5a;
            text-decoration: none;
            padding: 8px 16px;
            border: 1px solid #e0e0e0;
            border-radius: 4px;
            margin-right: 12px;
            margin-bottom: 12px;
            transition: all 0.15s ease;
        }

        .reference-link:hover {
            background: #fafafa;
            border-color: #d0d0d0;
        }

        .doc-reference {
            font-size: 12px;
            color: #a0a0a0;
            margin-top: 4px;
            font-style: italic;
        }

        @media (max-width: 768px) {
            .container {
                padding: 40px 32px;
            }

            .principle-grid {
                grid-template-columns: 1fr;
            }

            .environment-flow {
                flex-direction: column;
            }

            .arrow {
                transform: rotate(90deg);
                margin: 12px 0;
            }

            .workflow-step {
                grid-template-columns: 32px 1fr;
                gap: 16px;
            }

            .step-number {
                width: 32px;
                height: 32px;
                font-size: 14px;
            }
        }

        @media print {
            body {
                background: white;
                padding: 0;
            }

            .container {
                box-shadow: none;
                padding: 32px;
            }
        }
    </style>
</head>
<body>
    <div class="container">
        <div class="header">
            <h1>Development Workflow</h1>
            <p class="subtitle">A systematic approach to building, reviewing, and shipping code at Orcta</p>
        </div>

        <div class="section">
            <h2 class="section-title">Core Workflow</h2>

            <div class="workflow-step">
                <div class="step-number">1</div>
                <div class="step-content">
                    <h3>Start with Why</h3>
                    <p>Every feature begins with understanding the user need or pain point being addressed.</p>
                    <div class="step-details">
                        Before writing code, clarify the problem space. Link to the relevant issue or ticket. If none exists, document the user story or requirement first.
                    </div>
                    <div class="doc-reference">Engineering Philosophy, Section 3</div>
                </div>
            </div>

            <div class="workflow-step">
                <div class="step-number">2</div>
                <div class="step-content">
                    <h3>Design Before Implementation</h3>
                    <p>Think through architecture and approach before the first line of code.</p>
                    <div class="step-details">
                        For small changes, outline your approach in comments or notes. For larger features, write a brief design document or create a diagram. Share with the team for early feedback.
                    </div>
                    <div class="doc-reference">Engineering Philosophy, Section 3</div>
                </div>
            </div>

            <div class="workflow-step">
                <div class="step-number">3</div>
                <div class="step-content">
                    <h3>Build Simple, Then Abstract</h3>
                    <p>Start with the simplest implementation that solves the problem.</p>
                    <div class="step-details">
                        Avoid premature optimization or abstraction. If you find yourself building for hypothetical future requirements, step back and focus on the current need. Abstractions emerge naturally after patterns repeat.
                    </div>
                    <div class="doc-reference">Engineering Philosophy, Section 2</div>
                </div>
            </div>

            <div class="workflow-step">
                <div class="step-number">4</div>
                <div class="step-content">
                    <h3>Test Your Implementation</h3>
                    <p>Write tests that validate both happy paths and edge cases.</p>
                    <div class="step-details">
                        Unit tests for business logic are required. Integration tests for user-facing features are expected. Aim for 80% coverage on core services. Run tests locally before committing.
                    </div>
                    <div class="doc-reference">Engineering Playbook, Section 7</div>
                </div>
            </div>

            <div class="workflow-step">
                <div class="step-number">5</div>
                <div class="step-content">
                    <h3>Refactor as You Go</h3>
                    <p>Improve code quality incrementally rather than accumulating technical debt.</p>
                    <div class="step-details">
                        When you encounter duplicated code, unclear naming, or confusing logic, fix it immediately. The best time to refactor is when the context is fresh in your mind.
                    </div>
                    <div class="doc-reference">Engineering Philosophy, Section 3</div>
                </div>
            </div>

            <div class="workflow-step">
                <div class="step-number">6</div>
                <div class="step-content">
                    <h3>Submit for Review</h3>
                    <p>Create a pull request with clear description and context.</p>
                    <div class="step-details">
                        Use the PR template. Include what changed, why it changed, and how to test. Link to related issues. Add screenshots for UI changes. Request review from at least one team member.
                    </div>
                    <div class="doc-reference">Engineering Playbook, Section 5</div>
                </div>
            </div>

            <div class="workflow-step">
                <div class="step-number">7</div>
                <div class="step-content">
                    <h3>Address Feedback</h3>
                    <p>Engage with reviewer comments thoughtfully and promptly.</p>
                    <div class="step-details">
                        Respond to all feedback within 24 hours. If you disagree with a suggestion, explain your reasoning. Make requested changes or discuss alternatives. Reviews are collaborative, not adversarial.
                    </div>
                    <div class="doc-reference">Engineering Playbook, Section 5</div>
                </div>
            </div>

            <div class="workflow-step">
                <div class="step-number">8</div>
                <div class="step-content">
                    <h3>Monitor After Deploy</h3>
                    <p>Track your changes in production to catch issues early.</p>
                    <div class="step-details">
                        After merging, monitor logs and metrics for at least one hour. Set up relevant alerts if needed. If issues arise, address them quickly or revert. Ownership extends beyond the merge button.
                    </div>
                    <div class="doc-reference">Engineering Playbook, Section 6</div>
                </div>
            </div>
        </div>

        <div class="section">
            <h2 class="section-title">Deployment Environments</h2>
            <div class="environment-flow">
                <div class="env-item">
                    <div class="env-name">Development</div>
                    <div class="env-description">Active development and testing</div>
                </div>
                <div class="arrow">→</div>
                <div class="env-item">
                    <div class="env-name">Staging</div>
                    <div class="env-description">Pre-production validation</div>
                </div>
                <div class="arrow">→</div>
                <div class="env-item">
                    <div class="env-name">Production</div>
                    <div class="env-description">Live user traffic</div>
                </div>
            </div>
            <div class="step-details" style="margin-top: 20px; border-left: none; padding-left: 0;">
                Every change flows through all three environments. Deploy to development freely for testing. Deploy to staging after tests pass. Deploy to production only with tech lead approval after staging validation.
            </div>
            <div class="doc-reference">Engineering Playbook, Section 6</div>
        </div>

        <div class="section">
            <h2 class="section-title">Code Review Principles</h2>
            <div class="principle-grid">
                <div class="principle-card">
                    <h3>Focus on Clarity</h3>
                    <p>Code should be understandable by someone unfamiliar with the context. Prioritize readability over cleverness.</p>
                </div>
                <div class="principle-card">
                    <h3>Assume Positive Intent</h3>
                    <p>Approach reviews collaboratively. Authors did their best. Reviewers want to help improve the code.</p>
                </div>
                <div class="principle-card">
                    <h3>Be Specific</h3>
                    <p>Vague feedback like "this could be better" is not helpful. Point to specific lines and suggest concrete improvements.</p>
                </div>
                <div class="principle-card">
                    <h3>Ask Questions</h3>
                    <p>When uncertain about an approach, ask why rather than demanding changes. Understanding comes first.</p>
                </div>
            </div>
            <div class="doc-reference" style="margin-top: 16px;">Engineering Playbook, Section 5</div>
        </div>

        <div class="section">
            <h2 class="section-title">Pre-Submission Checklist</h2>
            <ul class="checklist">
                <li>All tests pass locally</li>
                <li>Linter shows no errors</li>
                <li>Code follows naming conventions</li>
                <li>New functionality includes tests</li>
                <li>Documentation updated where relevant</li>
                <li>No secrets or credentials committed</li>
                <li>Commit messages are descriptive</li>
                <li>PR description explains what and why</li>
            </ul>
            <div class="doc-reference" style="margin-top: 16px;">Engineering Playbook, Section 5.2</div>
        </div>

        <div class="section">
            <h2 class="section-title">Naming Conventions</h2>
            <div style="margin-top: 24px;">
                <h3 style="font-size: 16px; font-weight: 600; margin-bottom: 16px; color: #1a1a1a;">JavaScript & TypeScript</h3>
                <div class="code-convention">
                    <span class="convention-label">Variables</span>
                    <span class="convention-value">camelCase</span>
                </div>
                <div class="code-convention">
                    <span class="convention-label">Functions</span>
                    <span class="convention-value">camelCase</span>
                </div>
                <div class="code-convention">
                    <span class="convention-label">Components</span>
                    <span class="convention-value">PascalCase</span>
                </div>
                <div class="code-convention">
                    <span class="convention-label">Constants</span>
                    <span class="convention-value">SCREAMING_SNAKE_CASE</span>
                </div>
                <div class="code-convention">
                    <span class="convention-label">Files</span>
                    <span class="convention-value">kebab-case</span>
                </div>
            </div>

            <div style="margin-top: 32px;">
                <h3 style="font-size: 16px; font-weight: 600; margin-bottom: 16px; color: #1a1a1a;">Python</h3>
                <div class="code-convention">
                    <span class="convention-label">Variables</span>
                    <span class="convention-value">snake_case</span>
                </div>
                <div class="code-convention">
                    <span class="convention-label">Functions</span>
                    <span class="convention-value">snake_case</span>
                </div>
                <div class="code-convention">
                    <span class="convention-label">Classes</span>
                    <span class="convention-value">PascalCase</span>
                </div>
                <div class="code-convention">
                    <span class="convention-label">Constants</span>
                    <span class="convention-value">SCREAMING_SNAKE_CASE</span>
                </div>
                <div class="code-convention">
                    <span class="convention-label">Files</span>
                    <span class="convention-value">kebab-case</span>
                </div>
            </div>

            <div style="margin-top: 32px;">
                <h3 style="font-size: 16px; font-weight: 600; margin-bottom: 16px; color: #1a1a1a;">Go</h3>
                <div class="code-convention">
                    <span class="convention-label">Variables</span>
                    <span class="convention-value">camelCase</span>
                </div>
                <div class="code-convention">
                    <span class="convention-label">Exported Types</span>
                    <span class="convention-value">PascalCase</span>
                </div>
                <div class="code-convention">
                    <span class="convention-label">Packages</span>
                    <span class="convention-value">lowercase</span>
                </div>
                <div class="code-convention">
                    <span class="convention-label">Files</span>
                    <span class="convention-value">kebab-case</span>
                </div>
            </div>
            <div class="doc-reference" style="margin-top: 24px;">Naming Conventions Guide, Section 2</div>
        </div>

        <div class="reference-section">
            <h2 class="section-title">Reference Documentation</h2>
            <a href="#" class="reference-link">Engineering Philosophy</a>
            <a href="#" class="reference-link">Complete Playbook</a>
            <a href="#" class="reference-link">Naming Conventions</a>
            <a href="#" class="reference-link">Testing Strategy</a>
            <a href="#" class="reference-link">Architecture Guidelines</a>
        </div>
    </div>
</body>
</html>