Skip to content

Instantly share code, notes, and snippets.

@doevelopper
Created July 9, 2026 15:36
Show Gist options
  • Select an option

  • Save doevelopper/463be5240f0c279d2f2e2537408691b3 to your computer and use it in GitHub Desktop.

Select an option

Save doevelopper/463be5240f0c279d2f2e2537408691b3 to your computer and use it in GitHub Desktop.

11.4 Repository Folder Structure

All project documentation should be organized in a standardized folder structure to ensure consistency and ease of navigation:

.
├── .copilot
│   ├── agents
│   │   ├── product-owner-agent.agent.md
│   │   └── backlog-refinement-agent.agent.md
│   ├── commands
│   ├── context
│   │   ├── project-overview.md
│   │   ├── architecture-overview.md
│   │   ├── technology-stack.md
│   │   ├── coding-standards.md
│   │   ├── quality-gates.md
│   │   └── definition-of-done.md
│   ├── governance
│   ├── glossary
│   │   ├── domain-terms.md
│   │   ├── acronyms.md
│   │   └── business-rules.md
│   ├── hooks/
│   │   ├── license-compliance-gate.json
│   │   ├── post-code-generation-review-gate.json
│   │   ├── post-test-evidence-gate.json
│   │   ├── pre-code-generation-safety-gate.json
│   │   ├── pre-commit-quality-gate.json
│   │   ├── pre-pr-security-gate.json
│   │   ├── pre-task-context-gate.json
│   │   ├── qms-traceability-required-gate.json
│   │   ├── threat-model-required-gate.json
│   │   ├── release-evidence-completeness-gate.json
│   │   ├── sbom-required-gate.json
│   │   ├── secrets-leakage-gate.json
│   │   ├── pre-implementation.md
│   │   ├── post-implementation.md
│   │   ├── pre-commit.md
│   │   ├── post-commit.md
│   │   ├── pre-pr.md
│   │   ├── post-pr.md
│   │   ├── pre-release.md
│   │   ├── post-release.md
│   │   └── README.md
│   ├── instructions
│   ├── orchestration
│   │   ├── command-routing.md
│   │   ├── agent-selection-policy.md
│   │   ├── skill-selection-policy.md
│   │   ├── workflow-selection-policy.md
│   │   ├── output-contracts.md
│   │   ├── traceability-routing.md
│   │   └── human-approval-gates.md
│   ├── prompts
│   │   ├── split-prd-into-safe-backlog.prompt.md
│   │   ├── estimate-wsjf.prompt.md
│   │   ├── refine-user-stories.prompt.md
│   │   ├── create-adr.prompt.md
│   │   ├── review-adr.prompt.md
│   │   ├── architecture-tradeoff.prompt.md
│   │   └── interface-review.prompt.md
│   ├── quality-gates
│   │   ├── ai-output-definition-of-done.md
│   │   ├── secure-code-ai-review-gate.md
│   │   ├── generated-documentation-quality-gate.md
│   │   ├── hallucination-control.md
│   │   ├── evidence-required-before-merge.md
│   │   └── human-review-required.md
│   ├── safe
│   ├── skills
│   ├── templates
│   │   ├── prd-template.md
│   │   ├── theme-template.md
│   │   ├── epic-template.md
│   │   ├── user-story-template.md
│   │   ├── task-template.md
│   │   └── wsjf-weighting-template.md
│   └── workflows
│       ├── prd-to-safe-backlog.workflow.md
│       ├── prd-to-theme-epic-story-task.workflow.md
│       └── backlog-weighting.workflow.md
├── .github
│   ├── instructions
│   ├── ISSUE_TEMPLATE
│   ├── PULL_REQUEST_TEMPLATE
│   ├── prompts
│   └── workflows
│
├── .gitlab
│   ├── ISSUE_TEMPLATE
│   ├── MERGE_REQUEST_TEMPLATE
│   └── workflows
│
├── README.md
└── src
    ├── it						# BDD scenarios/features with @REQ tags (linked to URTP)
    │   ├── BUILD.bazel
    │   ├── README.md
    │   ├── <tld>
    │   │   └── <mycompany>
    │   │       └── <plant>
    │   │           └── <project>
    │   │               ├── <module>
    │   │               │   └── features
    │   │               │      ├── support
    │   │               │      └── step_definitions
    │   │               ├── <module 1>
    │   │               │   └── features
    │   │               │      ├── support
    │   │               │      └── step_definitions
    │   │               ├── <...>
    │   │               │   └── features
    │   │               │      ├── support
    │   │               │      └── step_definitions
    │   │               └── <module n>
    │   │                   └── features
    │   │                      ├── support
    │   │                      └── step_definitions
    │   ├── config
    │   │   ├── README.md
    │   │   ├── default
    │   │   ├── dev
    │   │   ├── prod
    │   │   ├── stage
    │   │   └── test
    │   │       └── log4cxx-integration-test.xml
    │   ├── main.<lang>
    │   └── resources
    │       └── bazel
    ├── main					#Production source code
    │   ├── config
    │   │   ├── README.md
    │   │   ├── default
    │   │   ├── dev
    │   │   │   └── log4cxx-development.xml
    │   │   ├── prod
    │   │   │   └── log4cxx-production.xml
    │   │   ├── stage
    │   │   │   └── log4cxx-staging.xml
    │   │   └── log4cxx.xml
    │   ├── <lang>
    │   │   ├── BUILD.bazel
    │   │   ├── <tld>
    │   │   │   └── <mycompany>
    │   │   │       └── <plant>
    │   │   │           └── <project>
    │   │   │           	├── <module>
    │   │   │           	├── <module 1>
    │   │   │           	├── <...>
    │   │   │           	└── <module n>
    │   │   └── main.<lang>
    │   └── resources
    │       ├── bazel
    │       ├── schemas
    │       ├── makefiles
    │       ├── cmake
    │       │   └── Dependencies.cmake
    │       └── xslts
    │           ├── cppcheck.xslt
    │           └── lizard-cca.xslt
    ├── site
    │   ├── automation                                            # compliance and traceability scripts
    │   │   ├── compliance
    │   │   │   ├── check_compliance.py
    │   │   │   ├── compliance_rules.yaml
    │   │   │   └── README.md
    │   │   ├── traceability
    │   │   │   ├── check_traceability.py
    │   │   │   ├── traceability_rules.yaml
    │   │   │   ├── id_patterns.yaml
    │   │   │   └── README.md
    │   │   ├── evidence
    │   │   │   ├── collect_evidence.py
    │   │   │   ├── evidence_schema.yaml
    │   │   │   └── README.md
    │   │   ├── schemas
    │   │   │   ├── requirement.schema.yaml
    │   │   │   ├── test.schema.yaml
    │   │   │   ├── threat.schema.yaml
    │   │   │   ├── risk.schema.yaml
    │   │   │   ├── evidence.schema.yaml
    │   │   │   ├── release.schema.yaml
    │   │   │   └── README.md
    │   │   ├── validators
    │   │   │   ├── validate_markdown_metadata.py
    │   │   │   ├── validate_links.py
    │   │   │   ├── validate_trace_ids.py
    │   │   │   └── README.md
    │   │   └── README.md
    │   ├── secure-sdlc
    │   │   ├── README.md
    │   │   ├── 00_Lifecycle_Model
    │   │   │   ├── SDLC-<PROJ>-Secure-Development-Lifecycle.md
    │   │   │   └── README.md
    │   │   ├── 01_Security_Requirements
    │   │   │   ├── SecReq-<PROJ>-Security-Requirements-Process.md
    │   │   │   └── README.md
    │   │   ├── 02_Secure_Architecture
    │   │   │   ├── SecArch-<PROJ>-Secure-Architecture-Review.md
    │   │   │   └── README.md
    │   │   ├── 03_Threat_Modeling
    │   │   │   ├── TM-<PROJ>-Threat-Model.md
    │   │   │   └── README.md
    │   │   ├── 04_Secure_Implementation
    │   │   │   ├── SCI-<PROJ>-Secure-Coding-Implementation.md
    │   │   │   └── README.md
    │   │   ├── 05_Secure_Code_Review
    │   │   │   ├── SCR-<PROJ>-Secure-Code-Review-Record.md
    │   │   │   └── README.md
    │   │   ├── 06_Security_Testing
    │   │   │   ├── SecTest-<PROJ>-Security-Test-Strategy.md
    │   │   │   └── README.md
    │   │   ├── 07_Supply_Chain_Security
    │   │   │   ├── SCS-<PROJ>-Supply-Chain-Security-Plan.md
    │   │   │   └── README.md
    │   │   ├── 08_Release_Security_Gates
    │   │   │   ├── RSG-<PROJ>-Release-Security-Gate.md
    │   │   │   └── README.md
    │   │   ├── 09_Vulnerability_Response
    │   │   │   ├── VRP-<PROJ>-Vulnerability-Response-Process.md
    │   │   │   └── README.md
    │   │   ├── 10_Post_Release_Monitoring
    │   │   │   ├── PRM-<PROJ>-Post-Release-Monitoring.md
    │   │   │   └── README.md
    │   │   └── 11_End_of_Life
    │   │       ├── EOL-<PROJ>-End-of-Life-Security-Plan.md
    │   │       └── README.md        
    │   ├── compliance                                                            # standard mappings and evidence
    │   │   ├── README.md
    │   │   ├── 00_Compliance_Strategy
    │   │   │   ├── COMP-<PROJ>-Compliance-Strategy.md
    │   │   │   └── README.md
    │   │   ├── 01_NIST_SSDF
    │   │   │   ├── NIST-SSDF-<PROJ>-Mapping.md
    │   │   │   └── README.md
    │   │   ├── 02_CISA_Secure_By_Design
    │   │   │   ├── CISA-SBD-<PROJ>-Mapping.md
    │   │   │   └── README.md
    │   │   ├── 03_IEC_62443
    │   │   │   ├── IEC62443-<PROJ>-Mapping.md
    │   │   │   └── README.md
    │   │   ├── 04_EU_CRA
    │   │   │   ├── EUCRA-<PROJ>-Mapping.md
    │   │   │   └── README.md
    │   │   ├── 05_ETSI_EN_303_645
    │   │   │   ├── ETSI303645-<PROJ>-Mapping.md
    │   │   │   └── README.md
    │   │   └── 99_Evidence_Index
    │   │       ├── COMP-EVID-<PROJ>-Compliance-Evidence-Index.md
    │   │       └── README.md
    │   ├── safe
    │   │   ├── README.md
    │   │   ├── 00_Vision
    │   │   │   ├── VISION-<PROJ>-Product-Vision.md
    │   │   │   └── README.md
    │   │   ├── 01_Roadmap
    │   │   │   ├── ROADMAP-<PROJ>-Product-Roadmap.md
    │   │   │   └── README.md
    │   │   ├── 02_Solution_Context
    │   │   │   ├── SOLCTX-<PROJ>-Solution-Context.md
    │   │   │   └── README.md
    │   │   ├── 03_ART_Backlog
    │   │   │   ├── THEME-<PROJ>-Theme-Backlog.md
    │   │   │   ├── EPIC-<PROJ>-Epic-Backlog.md
    │   │   │   ├── FEAT-<PROJ>-Feature-Backlog.md
    │   │   │   ├── STORY-<PROJ>-User-Story-Backlog.md
    │   │   │   ├── TASK-<PROJ>-Task-Backlog.md
    │   │   │   ├── ENABLER-<PROJ>-Enabler-Backlog.md
    │   │   │   ├── SECENABLER-<PROJ>-Security-Enabler-Backlog.md
    │   │   │   ├── NFR-<PROJ>-NFR-Backlog.md
    │   │   │   ├── WSJF-<PROJ>-Weighted-Shortest-Job-First.md
    │   │   │   └── README.md
    │   │   ├── 04_Team_Backlogs
    │   │   │   ├── TEAMB-<PROJ>-Team-Backlogs.md
    │   │   │   └── README.md
    │   │   ├── 05_PI_Planning
    │   │   │   ├── PI-<PROJ>-PI-Planning.md
    │   │   │   ├── PIOBJ-<PROJ>-PI-Objectives.md
    │   │   │   ├── ROAM-<PROJ>-PI-Risks.md
    │   │   │   └── README.md
    │   │   ├── 06_System_Demos
    │   │   │   ├── SYSDEMO-<PROJ>-System-Demo-Evidence.md
    │   │   │   └── README.md
    │   │   ├── 07_Inspect_And_Adapt
    │   │   │   ├── IA-<PROJ>-Inspect-and-Adapt-Report.md
    │   │   │   └── README.md
    │   │   └── 08_Architectural_Runway
    │   │       ├── AR-<PROJ>-Architectural-Runway.md
    │   │       └── README.md
    │   ├── supply-chain
    │   │   ├── README.md
    │   │   ├── 00_Strategy
    │   │   │   ├── SCS-<PROJ>-Supply-Chain-Security-Strategy.md
    │   │   │   └── README.md
    │   │   ├── 01_SBOM
    │   │   │   ├── SBOM-<PROJ>-Software-Bill-of-Materials.md
    │   │   │   ├── SBOM-<PROJ>-Generation-Procedure.md
    │   │   │   └── README.md
    │   │   ├── 02_VEX
    │   │   │   ├── VEX-<PROJ>-Vulnerability-Exploitability-Exchange.md
    │   │   │   └── README.md
    │   │   ├── 03_Provenance
    │   │   │   ├── PROV-<PROJ>-Build-Provenance.md
    │   │   │   └── README.md
    │   │   ├── 04_Signing
    │   │   │   ├── SIGN-<PROJ>-Artifact-Signing-Policy.md
    │   │   │   ├── KYM-<PROJ>-key-management.md
    │   │   │   └── README.md
    │   │   ├── 05_Dependencies
    │   │   │   ├── DEP-<PROJ>-Dependency-Management-Policy.md
    │   │   │   └── README.md
    │   │   └── 06_Third_Party
    │   │       ├── TPS-<PROJ>-Third-Party-Software-Register.md
    │   │       └── README.md
    │   ├── vulnops                   # vulnerability operations
    │   │   ├── README.md
    │   │   ├── 00_Intake
    │   │   │   ├── VULN-<PROJ>-Vulnerability-Intake.md
    │   │   │   └── README.md
    │   │   ├── 01_Triage
    │   │   │   ├── VTRIAGE-<PROJ>-Vulnerability-Triage.md
    │   │   │   └── README.md
    │   │   ├── 02_Exploitability
    │   │   │   ├── EXP-<PROJ>-Exploitability-Assessment.md
    │   │   │   └── README.md
    │   │   ├── 03_Remediation
    │   │   │   ├── REM-<PROJ>-Remediation-Plan.md
    │   │   │   └── README.md
    │   │   ├── 04_Disclosure
    │   │   │   ├── DISC-<PROJ>-Coordinated-Disclosure-Process.md
    │   │   │   └── README.md
    │   │   ├── 05_Advisories
    │   │   │   ├── ADV-<PROJ>-Security-Advisory.md
    │   │   │   └── README.md
    │   │   └── 06_Metrics
    │   │       ├── VMET-<PROJ>-Vulnerability-Metrics.md
    │   │       └── README.md 
    │   ├── repo-operations
    │   │   ├── github-gitlab-sync-strategy.md
    │   │   ├── branch-protection-policy.md
    │   │   ├── merge-policy.md
    │   │   ├── release-tagging-policy.md
    │   │   ├── mirror-repository-policy.md
    │   │   └── access-control-model.md        
    │   └── qms                             
    │       ├── 00_PRD                      # Product Requirements Document(s)
    │       │   ├── README.md
    │       │   └── PRD-<PROJ>-Product-Requirements-Document.md
    │       ├── 01_Plans                    # Governance and planning documents
    │       │   ├── PMP-<PROJ>-Project-Management-Plan.md
    │       │   ├── SDP-<PROJ>-Software-Development-Plan.md
    │       │   ├── SCMP-<PROJ>-Software-Configuration-Management-Plan.md
    │       │   ├── SQAP-<PROJ>-Software-Quality-Assurance-Plan.md
    │       │   ├── SVVP-<PROJ>-Software-Verification-and-Validation-Plan.md            
    │       │   └── README.md
    │       ├── 02_ConOps
    │       │   └── README.md
    │       ├── 03_StRS
    │       │   └── README.md
    │       ├── 04_URS
    │       │   └── README.md
    │       ├── 05_SysRS
    │       │   └── README.md
    │       ├── 06_SwRS
    │       │   └── README.md
    │       ├── 07_HwRS
    │       │   └── README.md
    │       ├── 08_MechRS
    │       │   └── README.md
    │       ├── 09_SafetyRS
    │       │   └── README.md
    │       ├── 10_SecRS
    │       │   └── README.md
    │       ├── 11_Architecture
    │       │   ├── SAD-<PROJ>-System-Architecture-Description.md
    │       │   ├── SArchD-<PROJ>-Software-Architecture-Document.md
    │       │   ├── DATADICT-<PROJ>-Data-Dictionary.md            
    │       │   └── README.md
    │       ├── 12_ElecDD
    │       │   ├── ElecDD-<PROJ>-Electronic-Design-Description.md
    │       │   └── README.md
    │       ├── 13_MechDD
    │       │   ├── MechDD-<PROJ>-Mechanical-Design-Description.md
    │       │   └── README.md
    │       ├── 14_HwBOM
    │       ├── HwBOM-<PROJ>-Hardware-Bill-of-Materials.md
    │       │   └── README.md
    │       ├── 15_ICD
    │       │   ├── ICD-<PROJ>-<InterfaceName>-Interface-Control-Document.md
    │       │   ├── ICD-<PROJ>-<InterfaceName 2>-Interface-Control-Document.md
    │       │   └── README.md
    │       ├── 16_SDD
    │       │   ├── SDD-<PROJ>-Software-Design-Description.md
    │       │   └── README.md
    │       ├── 17_ADR
    │       │   ├── ADR-<PROJ>-Architecture-Decision-Record.md
    │       │   └── README.md
    │       ├── 18_TestPlans
    │       │   ├── StRTP-<PROJ>-Stakeholder-Test-Plan.md
    │       │   ├── URTP-<PROJ>-User-Requirements-Test-Plan.md
    │       │   ├── SysRTP-<PROJ>-System-Requirements-Test-Plan.md
    │       │   ├── SwTP-<PROJ>-Software-Test-Plan.md
    │       │   ├── HwTP-<PROJ>-Hardware-Test-Plan.md (Electronics)
    │       │   ├── MechTP-<PROJ>-Mechanical-Test-Plan.md
    │       │   ├── SafetyTP-<PROJ>-Safety-Test-Plan.md
    │       │   ├── SecTP-<PROJ>-Security-Test-Plan.md
    │       │   └── README.md
    │       ├── 19_TestReports
    │       │   ├── StRTR-<PROJ>-Stakeholder-Requirements-Test-Report.md
    │       │   ├── URTR-<PROJ>-User-Requirements-Test-Report.md            
    │       │   ├── SysRTR-<PROJ>-System-Requirements-Test-Report.md
    │       │   ├── SwTR-<PROJ>-Software-Test-Report.md
    │       │   ├── HwTR-<PROJ>-Hardware-Test-Report.md (Electronics)
    │       │   ├── MechTR-<PROJ>-Mechanical-Test-Report.md
    │       │   ├── SafetyTR-<PROJ>-Safety-Test-Report.md
    │       │   ├── SecTR-<PROJ>-Security-Test-Report.md
    │       │   └── README.md
    │       ├── 20_RTM
    │       │   ├── TTM-<PROJ>-Requirements-Traceability-Matrix.md
    │       │   ├── RTM-<PROJ>-Requirements-Traceability-Matrix.yaml
    │       │   ├── RTM-<PROJ>-Requirements-Traceability-Matrix.csv            
    │       │   └── README.md
    │       ├── 21_TTM
    │       │   ├── TTM-<PROJ>-Tests-Traceability-Matrix.md
    │       │   ├── TTM-<PROJ>-Tests-Traceability-Matrix.yaml
    │       │   ├── TTM-<PROJ>-Tests-Traceability-Matrix.csv            
    │       │   └── README.md
    │       ├── 22_TRTM
    │       │   ├── TRTM-<PROJ>-Threats-Requirements-Traceability-Matrix.md
    │       │   ├── TRTM-<PROJ>-Threats-Requirements-Traceability-Matrix.yaml
    │       │   ├── TRTM-<PROJ>-Threats-Requirements-Traceability-Matrix.csv            
    │       │   └── README.md
    │       ├── 23_Risk_Compliance
    │       │   ├── RISK-<PROJ>-Risk-Register-and-Mitigation.md
    │       │   ├── SEC-<PROJ>-Threat-Model-and-Security-Plan.md
    │       │   ├── SAF-<PROJ>-Safety-Requirements-and-Analysis.md
    │       │   ├── REL-<PROJ>-Reliability-and-Stress-Test-Plan.md            
    │       │   └── README.md
    │       ├── 24_Change_Mgmt
    │       │   ├── CHG-<PROJ>-Change-Request-Log.md
    │       │   ├── DEF-<PROJ>-Defect-Log-and-Triage.md
    │       │   ├── ECO-<PROJ>-Engineering-Change-Order-Log.md
    │       │   └── README.md
    │       ├── 25_Release
    │       │   ├── RELNOTES-<PROJ>-Release-Notes.md
    │       │   ├── SBOM-<PROJ>-Software-Bill-of-Materials.md
    │       │   ├── INST-<PROJ>-Installation-and-Commissioning-Guide.md
    │       │   ├── OPS-<PROJ>-Operations-Manual.md
    │       │   ├── SRV-<PROJ>-Service-and-Diagnostics-Guide.md            
    │       │   └── README.md
    │       ├── 26_Supporting
    │       │   └── README.md
    │       ├── 27_Templates
    │       │   ├── ADR-template.md
    │       │   ├── PRD-template.md
    │       │   ├── RISK-template.md
    │       │   ├── ...
    │       │   ├── SVVP-template.md            
    │       │   └── README.md
    │       ├── 28_Evidence
    │       │   ├── EVID-<PROJ>-Evidence-Index.md
    │       │   ├── EVID-<PROJ>-Evidence-Index.yaml
    │       │   ├── EVID-<PROJ>-Build-Evidence.md
    │       │   ├── EVID-<PROJ>-Test-Evidence.md
    │       │   ├── EVID-<PROJ>-Security-Evidence.md
    │       │   ├── EVID-<PROJ>-Release-Evidence.md
    │       │   └── README.md
    │       ├── 29_Reviews_and_Approvals
    │       │   └── README.md
    │       ├── 30_Audit
    │       │   └── README.md
    │       ├── 31_Training
    │       │   └── README.md
    │       ├── 32_Measurements            
    │       │   └── README.md
    │       ├── Project_Documentation_and_Traceability_Standard.md
    │       └── README.md
    └── test                # Unit tests (traceable to SwTP)
          ├── config
          │   ├── README.md
          │   ├── default
          │   ├── dev
          │   ├── prod
          │   ├── stage
          │   ├── test
          │   ├── log4cxx-unit-test.xml
          │   └── log4cxx.properties
          ├── <lang>
          │   ├── BUILD.bazel
          │   ├── <tld>
          │   │   └── <mycompany>
          │   │       └── <project>
          │   │           └── <project>
          │   │           	├── <module>
          │   │           	├── <module 1>
          │   │           	├── <...>
          │   │           	└── <module n>
          │   └── main.<lang>
          └── resources
              ├── bazel
              ├── makefiles
              ├── cmake
              │   ├── TestDependencies.cmake
              │   └── TestGoals.cmake
              └── xslts
                  ├── cobertura.xslt
                  └── gtest2html.xslt            
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment