# yuvrajtak07/technical-writing-portfolio architecture
> Architecture diagram of the GitHub repository yuvrajtak07/technical-writing-portfolio, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-12). It is an AI-made overview: check details against the source.
- Interactive diagram: https://gitdiagram.com/yuvrajtak07/technical-writing-portfolio
- Repository: https://github.com/yuvrajtak07/technical-writing-portfolio
## Overview
This repository is a learning portfolio, not an application: learners choose a technical-writing topic, read its material, inspect an example, and modify or compile it where applicable. Its major branches cover document authoring, code documentation, and version control. The README documents the topic map and compile/run steps, but no source excerpts were provided, so relationships below are limited to those documented there.
Main entry points: [`02-google-docs`](https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/02-google-docs) (Google Docs), [`04-beamer/presentation.tex`](https://github.com/yuvrajtak07/technical-writing-portfolio/blob/main/04-beamer/presentation.tex) (Beamer Slides), [`03-latex/01-first-document`](https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/03-latex/01-first-document) (Document Setup), [`03-latex/02-page-layout`](https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/03-latex/02-page-layout) (Page Layout)
## Diagram (Mermaid)
```mermaid
flowchart TD
subgraph group_authoring["Document Authoring"]
node_fundamentals["Writing Fundamentals"]
node_google_docs["Google Docs"]
node_docs_guides["Guides"]
node_report_template["Report Template"]
node_beamer["Beamer Slides
[presentation.tex]"]
node_resources["Learning References
[references.md]"]
end
subgraph group_latex["LaTeX Examples"]
node_latex_intro["Document Setup"]
node_latex_layout["Page Layout"]
node_latex_format["Formatting"]
node_latex_math["Mathematics"]
node_latex_tables["Tables and Images"]
node_latex_refs["Cross-References"]
node_latex_bib["Bibliography"]
node_latex_index["Index"]
end
subgraph group_codedocs["Code Documentation"]
node_doxygen_example["Doxygen Example"]
node_generated_docs["Generated API Docs"]
end
subgraph group_version["Version Control"]
node_git["Git"]
node_github["GitHub
[github-workflow.md]"]
end
node_learner(("Learner"))
node_latex_compiler["LaTeX Distribution"]
node_doxygen_tool["Doxygen Tool"]
node_learner -->|"chooses topic"| node_fundamentals
node_learner -->|"chooses topic"| node_google_docs
node_learner -->|"chooses topic"| node_latex_intro
node_learner -->|"chooses topic"| node_latex_layout
node_learner -->|"chooses topic"| node_latex_format
node_learner -->|"chooses topic"| node_latex_math
node_learner -->|"chooses topic"| node_latex_tables
node_learner -->|"chooses topic"| node_latex_refs
node_learner -->|"chooses topic"| node_latex_bib
node_learner -->|"chooses topic"| node_latex_index
node_learner -->|"chooses topic"| node_beamer
node_learner -->|"chooses topic"| node_doxygen_example
node_learner -->|"chooses topic"| node_git
node_learner -->|"chooses topic"| node_github
node_learner -->|"consults"| node_resources
node_google_docs -->|"includes guidance"| node_docs_guides
node_google_docs -->|"includes template"| node_report_template
node_learner -->|"compiles examples"| node_latex_compiler
node_latex_compiler -->|"builds example"| node_latex_intro
node_latex_compiler -->|"builds example"| node_latex_layout
node_latex_compiler -->|"builds example"| node_latex_format
node_latex_compiler -->|"builds example"| node_latex_math
node_latex_compiler -->|"builds example"| node_latex_tables
node_latex_compiler -->|"builds example"| node_latex_refs
node_latex_compiler -->|"builds example"| node_latex_bib
node_latex_compiler -->|"builds example"| node_latex_index
node_learner -->|"compiles presentation"| node_beamer
node_learner -->|"runs tool"| node_doxygen_tool
node_doxygen_tool -->|"reads configuration"| node_doxygen_example
node_doxygen_tool -->|"generates HTML"| node_generated_docs
click node_fundamentals "https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/01-documentation-fundamentals"
click node_google_docs "https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/02-google-docs"
click node_docs_guides "https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/02-google-docs/guides"
click node_report_template "https://github.com/yuvrajtak07/technical-writing-portfolio/blob/main/02-google-docs/templates/technical-report-outline.md"
click node_latex_intro "https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/03-latex/01-first-document"
click node_latex_layout "https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/03-latex/02-page-layout"
click node_latex_format "https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/03-latex/03-formatting"
click node_latex_math "https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/03-latex/04-mathematics"
click node_latex_tables "https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/03-latex/05-tables-and-images"
click node_latex_refs "https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/03-latex/06-cross-references"
click node_latex_bib "https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/03-latex/07-bibliography"
click node_latex_index "https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/03-latex/08-index"
click node_beamer "https://github.com/yuvrajtak07/technical-writing-portfolio/blob/main/04-beamer/presentation.tex"
click node_doxygen_example "https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/05-doxygen/example"
click node_generated_docs "https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/05-doxygen/generated-docs"
click node_git "https://github.com/yuvrajtak07/technical-writing-portfolio/blob/main/06-git-and-github/git-command-cheatsheet.md"
click node_github "https://github.com/yuvrajtak07/technical-writing-portfolio/blob/main/06-git-and-github/github-workflow.md"
click node_resources "https://github.com/yuvrajtak07/technical-writing-portfolio/blob/main/resources/references.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_fundamentals,node_google_docs,node_docs_guides,node_report_template,node_beamer,node_resources toneBlue
class node_latex_intro,node_latex_layout,node_latex_format,node_latex_math,node_latex_tables,node_latex_refs,node_latex_bib,node_latex_index toneAmber
class node_doxygen_example,node_generated_docs toneMint
class node_git,node_github toneRose
class node_learner,node_latex_compiler,node_doxygen_tool toneIndigo
```
## Components
### Document Authoring
- [Writing Fundamentals](https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/01-documentation-fundamentals): `01-documentation-fundamentals`
- [Google Docs](https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/02-google-docs): `02-google-docs`
- [Guides](https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/02-google-docs/guides): `02-google-docs/guides`
- [Report Template](https://github.com/yuvrajtak07/technical-writing-portfolio/blob/main/02-google-docs/templates/technical-report-outline.md): `02-google-docs/templates/technical-report-outline.md`
- [Beamer Slides](https://github.com/yuvrajtak07/technical-writing-portfolio/blob/main/04-beamer/presentation.tex): `04-beamer/presentation.tex`
- [Learning References](https://github.com/yuvrajtak07/technical-writing-portfolio/blob/main/resources/references.md): `resources/references.md`
### LaTeX Examples
- [Document Setup](https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/03-latex/01-first-document): `03-latex/01-first-document`
- [Page Layout](https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/03-latex/02-page-layout): `03-latex/02-page-layout`
- [Formatting](https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/03-latex/03-formatting): `03-latex/03-formatting`
- [Mathematics](https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/03-latex/04-mathematics): `03-latex/04-mathematics`
- [Tables and Images](https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/03-latex/05-tables-and-images): `03-latex/05-tables-and-images`
- [Cross-References](https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/03-latex/06-cross-references): `03-latex/06-cross-references`
- [Bibliography](https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/03-latex/07-bibliography): `03-latex/07-bibliography`
- [Index](https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/03-latex/08-index): `03-latex/08-index`
### Code Documentation
- [Doxygen Example](https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/05-doxygen/example): `05-doxygen/example`
- [Generated API Docs](https://github.com/yuvrajtak07/technical-writing-portfolio/tree/main/05-doxygen/generated-docs): `05-doxygen/generated-docs`
### Version Control
- [Git](https://github.com/yuvrajtak07/technical-writing-portfolio/blob/main/06-git-and-github/git-command-cheatsheet.md): `06-git-and-github/git-command-cheatsheet.md`
- [GitHub](https://github.com/yuvrajtak07/technical-writing-portfolio/blob/main/06-git-and-github/github-workflow.md): `06-git-and-github/github-workflow.md`
### Other components
- **Learner**
- **LaTeX Distribution**
- **Doxygen Tool**
## Connections
- Learner → Writing Fundamentals: chooses topic (evidence: `README.md`)
- Learner → Google Docs: chooses topic (evidence: `README.md`)
- Learner → Document Setup: chooses topic (evidence: `README.md`)
- Learner → Page Layout: chooses topic (evidence: `README.md`)
- Learner → Formatting: chooses topic (evidence: `README.md`)
- Learner → Mathematics: chooses topic (evidence: `README.md`)
- Learner → Tables and Images: chooses topic (evidence: `README.md`)
- Learner → Cross-References: chooses topic (evidence: `README.md`)
- Learner → Bibliography: chooses topic (evidence: `README.md`)
- Learner → Index: chooses topic (evidence: `README.md`)
- Learner → Beamer Slides: chooses topic (evidence: `README.md`)
- Learner → Doxygen Example: chooses topic (evidence: `README.md`)
- Learner → Git: chooses topic (evidence: `README.md`)
- Learner → GitHub: chooses topic (evidence: `README.md`)
- Learner → Learning References: consults (evidence: `README.md`)
- Google Docs → Guides: includes guidance (evidence: `README.md`)
- Google Docs → Report Template: includes template (evidence: `README.md`)
- Learner → LaTeX Distribution: compiles examples (evidence: `README.md`)
- LaTeX Distribution → Document Setup: builds example (evidence: `README.md`)
- LaTeX Distribution → Page Layout: builds example (evidence: `README.md`)
- LaTeX Distribution → Formatting: builds example (evidence: `README.md`)
- LaTeX Distribution → Mathematics: builds example (evidence: `README.md`)
- LaTeX Distribution → Tables and Images: builds example (evidence: `README.md`)
- LaTeX Distribution → Cross-References: builds example (evidence: `README.md`)
- LaTeX Distribution → Bibliography: builds example (evidence: `README.md`)
- LaTeX Distribution → Index: builds example (evidence: `README.md`)
- Learner → Beamer Slides: compiles presentation (evidence: `README.md`)
- Learner → Doxygen Tool: runs tool (evidence: `README.md`)
- Doxygen Tool → Doxygen Example: reads configuration (evidence: `README.md`)
- Doxygen Tool → Generated API Docs: generates HTML (evidence: `README.md`)