How yuvrajtak07/technical-writing-portfolio works
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 Google Docs · presentation.tex Beamer Slides · 01-first-document Document Setup · 02-page-layout Page Layout
Components 21
Document Authoring
- Writing Fundamentals
01-documentation-fundamentals - Google Docs
02-google-docs - Guides
02-google-docs/guides - Report Template
02-google-docs/templates/technical-report-outline.md - Beamer Slides
04-beamer/presentation.tex - Learning References
resources/references.md
LaTeX Examples
- Document Setup
03-latex/01-first-document - Page Layout
03-latex/02-page-layout - Formatting
03-latex/03-formatting - Mathematics
03-latex/04-mathematics - Tables and Images
03-latex/05-tables-and-images - Cross-References
03-latex/06-cross-references - Bibliography
03-latex/07-bibliography - Index
03-latex/08-index
Code Documentation
- Doxygen Example
05-doxygen/example - Generated API Docs
05-doxygen/generated-docs
Version Control
Other components
- Learner
- LaTeX Distribution
- Doxygen Tool
Connections 30
- Learner → Writing Fundamentals: chooses topic
README.md - Learner → Google Docs: chooses topic
README.md - Learner → Document Setup: chooses topic
README.md - Learner → Page Layout: chooses topic
README.md - Learner → Formatting: chooses topic
README.md - Learner → Mathematics: chooses topic
README.md - Learner → Tables and Images: chooses topic
README.md - Learner → Cross-References: chooses topic
README.md - Learner → Bibliography: chooses topic
README.md - Learner → Index: chooses topic
README.md - Learner → Beamer Slides: chooses topic
README.md - Learner → Doxygen Example: chooses topic
README.md - Learner → Git: chooses topic
README.md - Learner → GitHub: chooses topic
README.md - Learner → Learning References: consults
README.md - Google Docs → Guides: includes guidance
README.md - Google Docs → Report Template: includes template
README.md - Learner → LaTeX Distribution: compiles examples
README.md - LaTeX Distribution → Document Setup: builds example
README.md - LaTeX Distribution → Page Layout: builds example
README.md - LaTeX Distribution → Formatting: builds example
README.md - LaTeX Distribution → Mathematics: builds example
README.md - LaTeX Distribution → Tables and Images: builds example
README.md - LaTeX Distribution → Cross-References: builds example
README.md - LaTeX Distribution → Bibliography: builds example
README.md - LaTeX Distribution → Index: builds example
README.md - Learner → Beamer Slides: compiles presentation
README.md - Learner → Doxygen Tool: runs tool
README.md - Doxygen Tool → Doxygen Example: reads configuration
README.md - Doxygen Tool → Generated API Docs: generates HTML
README.md