# best-practice-and-impact/qa-of-code-guidance architecture

> Architecture diagram of the GitHub repository best-practice-and-impact/qa-of-code-guidance, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/best-practice-and-impact/qa-of-code-guidance
- Repository: https://github.com/best-practice-and-impact/qa-of-code-guidance
- Video tour (about a minute): https://gitdiagram.com/best-practice-and-impact/qa-of-code-guidance/video

## Overview

This repository is a published quality-guidance book for code used in analysis and research, not a runtime software library. The reader’s workflow is to navigate the book’s contents and consult guidance on principles, development practices, and project lifecycle tasks. The README confirms that book pages are referenced by the table of contents. The graph represents those documented navigation links; source excerpts were limited, so it does not infer finer-grained links between chapters.

Main entry points: [`book/_toc.yml`](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/_toc.yml) (Book contents), [`book/intro.md`](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/intro.md) (Introduction), [`book/principles.md`](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/principles.md) (Principles), [`book/learning.md`](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/learning.md) (Learning)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_orientation["Getting oriented"]
  node_intro["Introduction<br/>[intro.md]"]
  node_principles["Principles<br/>[principles.md]"]
  node_learning["Learning<br/>[learning.md]"]
end

subgraph group_code_practice["Code practice"]
  node_readable["Readable code<br/>[readable_code.md]"]
  node_modular["Modular code<br/>[modular_code.md]"]
  node_testing["Testing code<br/>[testing_code.md]"]
  node_data["Data<br/>[data.md]"]
  node_generative_ai["Generative AI<br/>[generative_ai.md]"]
end

subgraph group_project_work["Project work"]
  node_structure["Project structure"]
  node_documentation["Project documentation"]
  node_version_control["Version control<br/>[version_control.md]"]
  node_peer_review["Peer review<br/>[peer_review.md]"]
  node_continuous_integration["Continuous integration"]
  node_configuration["Configuration<br/>[configuration.md]"]
end

subgraph group_special_topics["Special topics"]
  node_managers["Managers’ guide<br/>[managers_guide.md]"]
  node_checklists["Checklists<br/>[checklists.md]"]
  node_tools["Tools<br/>[tools.md]"]
  node_glossary["Glossary<br/>[glossary.md]"]
end

node_reader(("Reader"))
node_contents["Book contents<br/>[_toc.yml]"]

node_reader -->|"opens"| node_contents
node_contents -->|"links to"| node_intro
node_contents -->|"links to"| node_principles
node_contents -->|"links to"| node_learning
node_contents -->|"links to"| node_readable
node_contents -->|"links to"| node_modular
node_contents -->|"links to"| node_testing
node_contents -->|"links to"| node_data
node_contents -->|"links to"| node_generative_ai
node_contents -->|"links to"| node_structure
node_contents -->|"links to"| node_documentation
node_contents -->|"links to"| node_version_control
node_contents -->|"links to"| node_peer_review
node_contents -->|"links to"| node_continuous_integration
node_contents -->|"links to"| node_configuration
node_contents -->|"links to"| node_managers
node_contents -->|"links to"| node_checklists
node_contents -->|"links to"| node_tools
node_contents -->|"links to"| node_glossary

click node_contents "https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/_toc.yml"
click node_intro "https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/intro.md"
click node_principles "https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/principles.md"
click node_learning "https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/learning.md"
click node_readable "https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/readable_code.md"
click node_modular "https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/modular_code.md"
click node_testing "https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/testing_code.md"
click node_data "https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/data.md"
click node_generative_ai "https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/generative_ai.md"
click node_structure "https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/project_structure.md"
click node_documentation "https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/project_documentation.md"
click node_version_control "https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/version_control.md"
click node_peer_review "https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/peer_review.md"
click node_continuous_integration "https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/continuous_integration.md"
click node_configuration "https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/configuration.md"
click node_managers "https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/managers_guide.md"
click node_checklists "https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/checklists.md"
click node_tools "https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/tools.md"
click node_glossary "https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/glossary.md"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_intro,node_principles,node_learning toneBlue
class node_readable,node_modular,node_testing,node_data,node_generative_ai toneAmber
class node_structure,node_documentation,node_version_control,node_peer_review,node_continuous_integration,node_configuration toneMint
class node_managers,node_checklists,node_tools,node_glossary toneRose
class node_reader toneIndigo
class node_contents toneTeal
```

## Components

### Getting oriented

- [Introduction](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/intro.md): `book/intro.md`
- [Principles](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/principles.md): `book/principles.md`
- [Learning](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/learning.md): `book/learning.md`

### Code practice

- [Readable code](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/readable_code.md): `book/readable_code.md`
- [Modular code](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/modular_code.md): `book/modular_code.md`
- [Testing code](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/testing_code.md): `book/testing_code.md`
- [Data](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/data.md): `book/data.md`
- [Generative AI](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/generative_ai.md): `book/generative_ai.md`

### Project work

- [Project structure](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/project_structure.md): `book/project_structure.md`
- [Project documentation](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/project_documentation.md): `book/project_documentation.md`
- [Version control](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/version_control.md): `book/version_control.md`
- [Peer review](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/peer_review.md): `book/peer_review.md`
- [Continuous integration](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/continuous_integration.md): `book/continuous_integration.md`
- [Configuration](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/configuration.md): `book/configuration.md`

### Special topics

- [Managers’ guide](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/managers_guide.md): `book/managers_guide.md`
- [Checklists](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/checklists.md): `book/checklists.md`
- [Tools](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/tools.md): `book/tools.md`
- [Glossary](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/glossary.md): `book/glossary.md`

### Other components

- **Reader**
- [Book contents](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/main/book/_toc.yml): `book/_toc.yml`

## Connections

- Reader → Book contents: opens
- Book contents → Introduction: links to
- Book contents → Principles: links to
- Book contents → Learning: links to
- Book contents → Readable code: links to
- Book contents → Modular code: links to
- Book contents → Testing code: links to
- Book contents → Data: links to
- Book contents → Generative AI: links to
- Book contents → Project structure: links to
- Book contents → Project documentation: links to
- Book contents → Version control: links to
- Book contents → Peer review: links to
- Book contents → Continuous integration: links to
- Book contents → Configuration: links to
- Book contents → Managers’ guide: links to
- Book contents → Checklists: links to
- Book contents → Tools: links to
- Book contents → Glossary: links to