How kushal-gajera/technical-writing-portfolio works
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 Portfolio overview · plotting/README.md Plotting guide · git-github/README.md Git guide · latex/README.md LaTeX guide
Components 24
Portfolio orientation
- Portfolio overview
README.md - Start guide
docs/START-HERE.md - Syllabus map
docs/syllabus-map.md
Document authoring
- LaTeX guide
docs/latex/README.md - LaTeX report
docs/latex/main.tex - Report chapters
docs/latex/chapters - Google Docs guide
docs/google-docs/guide.md - Report template
docs/google-docs/technical-report-template.md
Presentations
- Beamer guide
docs/beamer/README.md - Sample slide deck
docs/beamer/presentation.tex
Code documentation
- Doxygen guide
docs/doxygen/README.md - Calculator API
docs/doxygen/include/calculator.hpp - Calculator implementation
docs/doxygen/src/calculator.cpp - Doxygen
- HTML API reference
Visualization and sharing
- Drawing guide
docs/drawing/README.md - Plotting guide
docs/plotting/README.md - Plot script
docs/plotting/progress-plot.gp - Sample data
docs/plotting/sample-data.csv - Gnuplot
- Git guide
docs/git-github/README.md - Command cheat sheet
docs/git-github/command-cheatsheet.md - GitHub
Other components
- Learner
Connections 25
- Learner → Portfolio overview: opens
README.md - Portfolio overview → Start guide: directs to
README.md - Portfolio overview → Syllabus map: links to
README.md - Portfolio overview → LaTeX guide: links to
README.md - Portfolio overview → Google Docs guide: links to
README.md - Portfolio overview → Beamer guide: links to
README.md - Portfolio overview → Doxygen guide: links to
README.md - Portfolio overview → Drawing guide: links to
README.md - Portfolio overview → Plotting guide: links to
README.md - Portfolio overview → Git guide: links to
README.md - LaTeX guide → LaTeX report: guides work on
README.md - LaTeX report → Report chapters: split into
README.md - Google Docs guide → Report template: pairs with
README.md - Beamer guide → Sample slide deck: guides editing
README.md - Doxygen guide → Calculator API: documents example
README.md - Calculator API → Doxygen: provides commented source
README.md - Calculator implementation → Doxygen: provides commented source
README.md - Doxygen → HTML API reference: generates
README.md - Drawing guide → Learner: teaches diagramming
README.md - Plotting guide → Plot script: explains example
README.md - Plotting guide → Sample data: explains example
README.md - Plot script → Gnuplot: plots data with
README.md - Sample data → Gnuplot: feeds
README.md - Git guide → Command cheat sheet: offers commands
README.md - Git guide → GitHub: shares through
README.md