# kushal-gajera/technical-writing-portfolio architecture

> Architecture diagram of the GitHub repository kushal-gajera/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/kushal-gajera/technical-writing-portfolio
- Repository: https://github.com/kushal-gajera/technical-writing-portfolio

## Overview

This repository is a technical-writing course portfolio: learners use its overview and guides to explore example documents, slides, code documentation, diagrams, plotting, and version control. The main workflow is learning a topic, following its guide, and inspecting or adapting the corresponding example; selected examples demonstrate tool-generated outputs. The README documents these capabilities and links to the relevant materials. Source excerpts are limited to the structure-check script, so relationships below rely on README statements; internal behavior of unsampled files is not inferred.

Main entry points: [`README.md`](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/README.md) (Portfolio overview), [`docs/plotting/README.md`](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/plotting/README.md) (Plotting guide), [`docs/git-github/README.md`](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/git-github/README.md) (Git guide), [`docs/latex/README.md`](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/latex/README.md) (LaTeX guide)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_orientation["Portfolio orientation"]
  node_overview["Portfolio overview<br/>[README.md]"]
  node_start["Start guide<br/>[START-HERE.md]"]
  node_syllabus["Syllabus map<br/>[syllabus-map.md]"]
end

subgraph group_writing["Document authoring"]
  node_latex_guide["LaTeX guide<br/>[README.md]"]
  node_latex_report["LaTeX report<br/>[main.tex]"]
  node_latex_chapters["Report chapters"]
  node_google_guide["Google Docs guide<br/>[guide.md]"]
  node_google_template["Report template"]
end

subgraph group_presentations["Presentations"]
  node_beamer_guide["Beamer guide<br/>[README.md]"]
  node_slide_deck["Sample slide deck<br/>[presentation.tex]"]
end

subgraph group_code_docs["Code documentation"]
  node_doxygen_guide["Doxygen guide<br/>[README.md]"]
  node_calculator_header["Calculator API<br/>[calculator.hpp]"]
  node_calculator_impl["Calculator implementation<br/>[calculator.cpp]"]
  node_doxygen_tool{{"Doxygen"}}
  node_api_reference["HTML API reference"]
end

subgraph group_visualization_sharing["Visualization and sharing"]
  node_drawing_guide["Drawing guide<br/>[README.md]"]
  node_plotting_guide["Plotting guide<br/>[README.md]"]
  node_plot_script["Plot script<br/>[progress-plot.gp]"]
  node_plot_data["Sample data<br/>[sample-data.csv]"]
  node_gnuplot{{"Gnuplot"}}
  node_git_guide["Git guide<br/>[README.md]"]
  node_git_cheatsheet["Command cheat sheet"]
  node_github{{"GitHub"}}
end

node_learner(("Learner"))

node_learner -->|"opens"| node_overview
node_overview -->|"directs to"| node_start
node_overview -->|"links to"| node_syllabus
node_overview -->|"links to"| node_latex_guide
node_overview -->|"links to"| node_google_guide
node_overview -->|"links to"| node_beamer_guide
node_overview -->|"links to"| node_doxygen_guide
node_overview -->|"links to"| node_drawing_guide
node_overview -->|"links to"| node_plotting_guide
node_overview -->|"links to"| node_git_guide
node_latex_guide -->|"guides work on"| node_latex_report
node_latex_report -->|"split into"| node_latex_chapters
node_google_guide -->|"pairs with"| node_google_template
node_beamer_guide -->|"guides editing"| node_slide_deck
node_doxygen_guide -->|"documents example"| node_calculator_header
node_calculator_header -->|"provides commented source"| node_doxygen_tool
node_calculator_impl -->|"provides commented source"| node_doxygen_tool
node_doxygen_tool -->|"generates"| node_api_reference
node_drawing_guide -->|"teaches diagramming"| node_learner
node_plotting_guide -->|"explains example"| node_plot_script
node_plotting_guide -->|"explains example"| node_plot_data
node_plot_script -->|"plots data with"| node_gnuplot
node_plot_data -->|"feeds"| node_gnuplot
node_git_guide -->|"offers commands"| node_git_cheatsheet
node_git_guide -->|"shares through"| node_github

click node_overview "https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/README.md"
click node_start "https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/START-HERE.md"
click node_syllabus "https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/syllabus-map.md"
click node_latex_guide "https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/latex/README.md"
click node_latex_report "https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/latex/main.tex"
click node_latex_chapters "https://github.com/kushal-gajera/technical-writing-portfolio/tree/main/docs/latex/chapters"
click node_google_guide "https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/google-docs/guide.md"
click node_google_template "https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/google-docs/technical-report-template.md"
click node_beamer_guide "https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/beamer/README.md"
click node_slide_deck "https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/beamer/presentation.tex"
click node_doxygen_guide "https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/doxygen/README.md"
click node_calculator_header "https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/doxygen/include/calculator.hpp"
click node_calculator_impl "https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/doxygen/src/calculator.cpp"
click node_drawing_guide "https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/drawing/README.md"
click node_plotting_guide "https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/plotting/README.md"
click node_plot_script "https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/plotting/progress-plot.gp"
click node_plot_data "https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/plotting/sample-data.csv"
click node_git_guide "https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/git-github/README.md"
click node_git_cheatsheet "https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/git-github/command-cheatsheet.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_overview,node_start,node_syllabus toneBlue
class node_latex_guide,node_latex_report,node_latex_chapters,node_google_guide,node_google_template toneAmber
class node_beamer_guide,node_slide_deck toneMint
class node_doxygen_guide,node_calculator_header,node_calculator_impl,node_doxygen_tool,node_api_reference toneRose
class node_drawing_guide,node_plotting_guide,node_plot_script,node_plot_data,node_gnuplot,node_git_guide,node_git_cheatsheet,node_github,node_learner toneIndigo
```

## Components

### Portfolio orientation

- [Portfolio overview](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/README.md): `README.md`
- [Start guide](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/START-HERE.md): `docs/START-HERE.md`
- [Syllabus map](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/syllabus-map.md): `docs/syllabus-map.md`

### Document authoring

- [LaTeX guide](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/latex/README.md): `docs/latex/README.md`
- [LaTeX report](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/latex/main.tex): `docs/latex/main.tex`
- [Report chapters](https://github.com/kushal-gajera/technical-writing-portfolio/tree/main/docs/latex/chapters): `docs/latex/chapters`
- [Google Docs guide](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/google-docs/guide.md): `docs/google-docs/guide.md`
- [Report template](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/google-docs/technical-report-template.md): `docs/google-docs/technical-report-template.md`

### Presentations

- [Beamer guide](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/beamer/README.md): `docs/beamer/README.md`
- [Sample slide deck](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/beamer/presentation.tex): `docs/beamer/presentation.tex`

### Code documentation

- [Doxygen guide](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/doxygen/README.md): `docs/doxygen/README.md`
- [Calculator API](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/doxygen/include/calculator.hpp): `docs/doxygen/include/calculator.hpp`
- [Calculator implementation](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/doxygen/src/calculator.cpp): `docs/doxygen/src/calculator.cpp`
- **Doxygen**
- **HTML API reference**

### Visualization and sharing

- [Drawing guide](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/drawing/README.md): `docs/drawing/README.md`
- [Plotting guide](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/plotting/README.md): `docs/plotting/README.md`
- [Plot script](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/plotting/progress-plot.gp): `docs/plotting/progress-plot.gp`
- [Sample data](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/plotting/sample-data.csv): `docs/plotting/sample-data.csv`
- **Gnuplot**
- [Git guide](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/git-github/README.md): `docs/git-github/README.md`
- [Command cheat sheet](https://github.com/kushal-gajera/technical-writing-portfolio/blob/main/docs/git-github/command-cheatsheet.md): `docs/git-github/command-cheatsheet.md`
- **GitHub**

### Other components

- **Learner**

## Connections

- Learner → Portfolio overview: opens (evidence: `README.md`)
- Portfolio overview → Start guide: directs to (evidence: `README.md`)
- Portfolio overview → Syllabus map: links to (evidence: `README.md`)
- Portfolio overview → LaTeX guide: links to (evidence: `README.md`)
- Portfolio overview → Google Docs guide: links to (evidence: `README.md`)
- Portfolio overview → Beamer guide: links to (evidence: `README.md`)
- Portfolio overview → Doxygen guide: links to (evidence: `README.md`)
- Portfolio overview → Drawing guide: links to (evidence: `README.md`)
- Portfolio overview → Plotting guide: links to (evidence: `README.md`)
- Portfolio overview → Git guide: links to (evidence: `README.md`)
- LaTeX guide → LaTeX report: guides work on (evidence: `README.md`)
- LaTeX report → Report chapters: split into (evidence: `README.md`)
- Google Docs guide → Report template: pairs with (evidence: `README.md`)
- Beamer guide → Sample slide deck: guides editing (evidence: `README.md`)
- Doxygen guide → Calculator API: documents example (evidence: `README.md`)
- Calculator API → Doxygen: provides commented source (evidence: `README.md`)
- Calculator implementation → Doxygen: provides commented source (evidence: `README.md`)
- Doxygen → HTML API reference: generates (evidence: `README.md`)
- Drawing guide → Learner: teaches diagramming (evidence: `README.md`)
- Plotting guide → Plot script: explains example (evidence: `README.md`)
- Plotting guide → Sample data: explains example (evidence: `README.md`)
- Plot script → Gnuplot: plots data with (evidence: `README.md`)
- Sample data → Gnuplot: feeds (evidence: `README.md`)
- Git guide → Command cheat sheet: offers commands (evidence: `README.md`)
- Git guide → GitHub: shares through (evidence: `README.md`)