Technical Writing Portfolio

Welcome to my portfolio! Below are examples from my academic and professional work for varying types of projects in the sphere of business and technical writing. This portfolio is for potential clients or employers looking to gain some insight into my experience and skills as a technical writer.

Technical Writing

Software Documentation

This is the documentation section of my co-op training report. I built a system and thoroughly documented it, including system analysis, requirements, design, implementation, and testing. Irrelevant parts of the report (extra information about co-op) are redacted.

Software Documentation
User Manual

I wrote user manuals for the three different user types of the system I developed during my co-op. This is one of those manuals. It explains simply and effectively how to use the system, as well as bugs to be aware of.

User Manual
Requirements engineering

I wrote this report as part of a two-person final project in my Requirements Engineering class. The document, although hypothetical, is a thorough and concise example of documenting hardware specifications and proper use of technical language.

Requirements Specification
Research paper

I wrote this paper during my Computer Architecture class in college. The purpose was not only to gain experience in thorough technical research, but also to practice writing a report in the standard format for publishing technical research.

Research Paper
Software Project Management Plan

The software project management plan (SPMP) was the first report in a series of reports meant to outline the software development lifecycle (SDLC). My team and outlined the responsibilities each member would take on, a schedule to adhere to, and more.

Software Project Management Plan
Software Design

This software design document is the next stage of the SDLC after the SPMP. In it, we describe the components of the proposed system in detail, as well as present the database outline that will be used as a backbone for the system.

Software Design Document
Testing Document

The last stage of SDLC documentation is the testing document. At this point, my team and I completed the implementation of the system and began documenting our testing procedures. We attempted every plausible input scenario to gauge the system's response.

Testing Document

Content Writing

Technical Content

Machine Learning and Marketing: What You Need to Know: I wrote this test sample for a company that asked "Write a content piece for an experienced marketer who has heard about ML but knows nothing about it and is looking to find out whether it is something she needs to learn more about."

Blog Post
Google MFI

Google Switched to Mobile First Indexing – What it Means for 2019 SEO: This blog covers news about one of the technical aspects of SEO, specifically, optimizing a website for mobile viewing based on Google's requirements. The company I wrote it for caters to businesses concerned with SEO and driving traffic to their sites, so this topic provides valuable information to their clients.

Blog Post
Editor

From the Editor’s Desk: All the Small Things that Affect Tone: As an editor for a content marketing company, I was tasked with writing a few blogs about common editing issues. In this blog, I talk about tone, one of the most common reasons for a client to request a rewrite, and how it can be easily tackled.

Blog Post
Editing

From the Editor's Desk: Editing for Economy: Another post I wrote as an editor, this blog discusses getting the most value out of the fewest possible words. Editing for economy is a concept I learned while obtaining a certification in technical writing.

Blog Post
Inbound Marketing

Inbound Marketing Vs. Content Marketing: I wrote this while working for a content marketing company. Since most of their clients are businesses concerned with their marketing tatics, I thought this explanation of commonly used digital marketing catch-phrases would benefit their readers.

Blog Post
Content Marketing Media

8 Marketing Mediums That Need Written Content: Since the goal of this company is to sell their written content to businesses for marketing purposes, I wrote this article to encourage the audience (business marketers) to invest in more varied content, and more of it, hopefully driving traffic to the site and gaining some new customers.

Blog Post
Company Manifesto

I wrote this manifesto as a volunteer for a nonprofit education organization. The organization gave me notes and samples from all of their work that illustrated their core values. It was my job to condense it down to around 500 words that best summarized what they stand for. I have appended the initial analysis here with my final draft.

Company Manifesto
E-Newsletter

This was a volunteer project for a non-profit organization. I provided an outline for a new, engaging e-newsletter template (graphics provided), using MailChimp. The goal was to improve audience interaction with monthly emails by organizing the layout of information in a more cohesive way.

E-Newsletter