Skip to content

Technical writing portfolio demonstrating structured content authoring, collaboration, clear writing and proofreading, and ability to grasp complex technical concepts quickly.

Notifications You must be signed in to change notification settings

MariaBHaque/Technical-Documentation-Portfolio

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Technical Writing Portfolio

👋 Hello! I'm Maria. I'm transitioning into technical documentation with a background in education and an MA in English Literature. This portfolio showcases my early documentation projects, demonstrating my ability to:

  • Write clear, task-based, user-centered documentation
  • Use Markdown, Git, and GitHub to manage docs
  • Create onboarding content and instructional guides

Projects Included

Project 1: Work Email & Calendar Setup Guide

A sample onboarding guide for new employees written in Markdown. Includes:

  • Step-by-step setup instructions
  • Troubleshooting contact info
  • FAQs

View the User Guide here

Skills Demonstrated

  • Structured writing for technical users
  • Markdown formatting best practices
  • Git/GitHub version control
  • Audience-aware tone and clarity

Project 2: Dog Adoption Site (In Progress)

A DITA project with structured XML topics.

  • Includes content, task, and reference topics
  • Designed for both first-time adopters and fostering agencies

View the Dog Adoption Project here

Skills Demonstrated

  • Structured XML authoring and topic-based architecture
  • Editing, clarifying requirements, and technical querying
  • UX-driven research and audience analysis
  • Scalable, reusable documentation with conditional filtering

More projects coming soon!

About

Technical writing portfolio demonstrating structured content authoring, collaboration, clear writing and proofreading, and ability to grasp complex technical concepts quickly.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published