How best-practice-and-impact/qa-of-code-guidance works
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: _toc.yml Book contents · intro.md Introduction · principles.md Principles · learning.md Learning
Components 20
Getting oriented
- Introduction
book/intro.md - Principles
book/principles.md - Learning
book/learning.md
Code practice
- Readable code
book/readable_code.md - Modular code
book/modular_code.md - Testing code
book/testing_code.md - Data
book/data.md - Generative AI
book/generative_ai.md
Project work
- Project structure
book/project_structure.md - Project documentation
book/project_documentation.md - Version control
book/version_control.md - Peer review
book/peer_review.md - Continuous integration
book/continuous_integration.md - Configuration
book/configuration.md
Special topics
- Managers’ guide
book/managers_guide.md - Checklists
book/checklists.md - Tools
book/tools.md - Glossary
book/glossary.md
Other components
- Reader
- Book contents
book/_toc.yml
Connections 19
- 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