UNPKG

aiwg

Version:

Cognitive architecture for AI-augmented software development with structured memory, ensemble validation, and closed-loop correction. FAIR-aligned artifacts, 84% cost reduction via human-in-the-loop, standards adopted by 100+ organizations.

aiwg.io

jmagly/aiwg

79 lines (45 loc) • 2.25 kB
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
# Programming Guidelines Template ## Cover Page - ``Project Name`` - `Programming Guidelines` - `Version`1.0`` ## Revision History | Date | Version | Description | Author | | --- | --- | --- | --- | | ``dd/mmm/yy``|``x.x``|`<details>`|`<name>` | ## Ownership & Collaboration - Document Owner: Environment Engineer - Contributor Roles: Implementer, Integrator - Automation Inputs: Language standards, static analysis rules - Automation Outputs: `programming-guidelines.md` with sections 1–9 ## 1 Introduction > Outline purpose, scope, terminology, references, and organization of the programming guidelines. ### 1.1 Purpose ### 1.2 Scope ### 1.3 Definitions, Acronyms, and Abbreviations ### 1.4 References ### 1.5 Overview ## 2 Language and Framework Standards > Enumerate supported languages, versions, frameworks, and compiler/interpreter settings. ## 3 Coding Conventions > Provide naming conventions, formatting, documentation, and commenting rules. ## 4 Error Handling and Logging > Describe standard patterns for exceptions, error codes, logging levels, and telemetry. ## 5 Security and Compliance Practices > Define secure coding requirements, data protection rules, and compliance considerations. ## 6 Performance and Resource Management > Provide guidance on performance optimization, memory management, and concurrency. ## 7 Testing Expectations > Document unit testing standards, code coverage targets, and mocking or test harness conventions. ## 8 Code Review Checklist > List criteria reviewers should apply to ensure adherence to these guidelines. ## 9 Tooling > Identify IDE configurations, linters, static analyzers, formatters, and automation used to enforce guidelines. ## Appendices (Optional) > Include snippets, templates, or references to style guides for specific languages. ## Agent Notes - List formatting rules and static analysis configurations explicitly for agent tooling. - Identify security and compliance requirements that code generators must respect. - Verify the Automation Outputs entry is satisfied before signaling completion. - Document formatting, linting, and static analysis rules for automation. - Include security and compliance requirements code generators must follow.