About the My Writing Repo

This repository contains writing samples that demonstrate my technical writing abilities.

If you want to learn more about me, my background, and my documentation process, check out my Wiki.

Documentation types

My technical writing samples are categorized into the following documentation types:

• Explainers
• How-tos
• Quickstart guides
• Reference guides
• Templates
• Tutorials

For all my writing samples, I followed the Google developer documentation style guide.

My writing samples

Document	Documentation type	Description
What You Need to Know About QR Codes	Explanation	This explanation article is written in Markdown and provides information on QR codes. I used VS Code and the explanation template from The Good Docs Project to create this explanation article.
How to Create and Push Files to a Remote Repository	How-to	This how-to article is written in Markdown and provides steps for creating files from your local computer and uploading them to your remote GitHub repository. I used VS Code and the how-to template from The Good Docs Project to create this how-to article.
DEV User Interface Components	Reference	This reference article is written in Markdown and provides information on the user interface (UI) elements of the DEV website homepage, a social media platform for software developers. I used VS Code and the reference template from The Good Docs Project create this reference article.
Git Commands	Reference	This reference article is written in Markdown and provides information on common Git commands. I used VS Code to create this reference article.
Marketing Campaigns Release Note	Release Note	This release note is written in Markdown and provides an overview of a hypothetical product's new features, improvements, and bug fixes. I used VS Code and the release notes template from The Good Docs Project to create this release note.
Contributing Guide	Template	This contributing guide and its accompanying guide are written in Markdown. I created this template when I was a contributor to The Good Docs Project. The purpose of this template is to provide a predefined format for open source projects to use for outlining and explaining guidelines to propsective contributors. I used VS Code to create the the template and accompanying guide.
Clone a GitHub Repository with GitHub Desktop	Tutorial	This tutorial is written in Markdown and provides detailed instructions on cloning a remote repository to your local computer with GitHub Desktop. I used VS Code and the tutorial template from The Good Docs Project to create this tutorial.
Create and Customize Your DEV Account	Tutorial	This tutorial is written in Markdown and provides detailed instructions on creating a DEV account with a GitHub account. I used VS Code and the tutorial template from The Good Docs Project to create this tutorial.
Create a GitHub Profile README	Quickstart	This quickstart guide is written in HTML5 and helps users to setup a profile README in GitHub as quickly as possible. I used VS Code and the quickstart template from The Good Docs Project to create this quickstart guide.