This repository contains a collection of my writing, primarily pieces from Git and GitHub workshops and my personal experiences utilizing these platforms.
My technical writing samples are categorized into the following documentation types:
- Explainers
- How-tos
- Quick start guides
- Reference guides
- Tutorials
Document | Documentation type | Description |
---|---|---|
What You Need to Know About QR Codes | Explanation | Provides a breakdown of QR codes and what they do. The audience for this document is nonspecialists who do not understand QR codes. I used the Good Docs Project's explanation template to create this document. |
How to Create and Push Files to a Remote Repository | How-to | Provides steps for creating files from your local computer and uploading them to your remote GitHub repository. The audience for this document is intermedia to expert users who need a quick rundown. I followed some of the concepts for writing procedures and documenting code syntax from Google's developer documentation style guide. I used The Good Docs Project's how-to template to create this document. |
DEV User Interface Components | Reference | Describes the user interface (UI) elements of the DEV website homepage, a social media platform for software developers. The audience for this document is DEV community members new to using the DEV website. I used the The Good Docs Project's reference template to create this document. |
Git Commands | Reference | Lists and describes common Git commands. The audience for this document is nonspecialists who need a reference guide for finding basic Git commands. |
Clone a GitHub Repository with GitHub Desktop | Tutorial | Provides instructions for cloning a remote repository to your local computer with GitHub Desktop. The audience for this document is nonspecialists who want to learn how to clone a remote repository with GitHub Desktop without using the command line. |
Create and Customize Your DEV Account | Tutorial | Provides instructions for creating a DEV account with a GitHub account. The audience for this document is users new to using DEV, a social media platform for software developers. |
Marketing Campaigns Release Note | Release Note | Describes new features, improvements, and bug fixes for a hypothetical product. The audience for this document is customers of the hypothetical product. |