Technical Writing

Complexity is a challenge for everyone. I strive to break down this complexity and provide an elementary, step-by-step process, whether a new piece of software the customer can use or an architecture view to modify an existing program.

Research and Analytical skills are my strong suits.  I love deep-diving into the area I need to document.  I investigate the requirements, design, create content, publish, and maintain the document.  Over the years, I have written Requirements, Architecture, Functional Descriptions, Detailed Designs, User Guides, Quick-Start Guides, and Step-By-Step manuals.  I’m experienced with Microsoft Word, Excel, PowerPoint, Adobe FrameMaker, and WordPress.

I have documented some of my side projects because most of my work has been on Enterprise systems, which I can’t share. This page provides several recent technical writing projects and how-to guides I have developed specifically for this website.  One, in particular, is from the Udemy “Professional Technical Writing Advance Your Writing Skills” certificate course, creating the “How to Paint a Room” how-to guide. 

Please click the links below to view the documents.

 

User Guides and Quick Reference Guides

How to create an AWS website project.

While earning my AWS certificate, I learned how to create an AWS WordPress website, www.greggroeten.net. I captured all the steps required for its creation. This 40-page technical document gives the exact step-by-step instructions. It discusses several areas, including VPC, IGW, NAT, EC2, SNS, IAM, ELB, and WordPress. I was the only author and used MS Word, SnipIt, and Grammarly.

How to paint a room project.

This project was fun to create. While earning a technical writing certificate from the Udemy course “Professional Technical Writing: Advance Your Writing Skills,” the final exam was to create a complete technical document. I wrote about painting a room like an expert and generated a 17-page guide.  I was the only author and used MS Word, SnipIt, and Grammarly.

Elementor Quick Start Guide

I am sharing a recent experience where I had trouble displaying a PDF on this web page. I found out that WordPress doesn’t have this functionality unless you download a PDF plugin.  Then, you have to watch videos to learn how it’s used.  So, I wanted to create a Quick Guide and show how quickly it can be done if you have the instructions on a single page. I was the only author and used MS PowerPoint and Paint.net.

 

Root Cause Analysis

 

JSF Web Application Server with AJAX Quick Reference.

While using AJAX messaging for a project, I couldn’t find a quick, comprehensive reference that showed the AJAX message flow. So, I created one. It begins with the application server and continues with the backend web container and the JSF framework. I was the only author and used MS PowerPoint and SnipIt.

 

Typical Network Quick Reference Diagram.

During a gateway project, I wanted to capture an overview of a network. This diagram describes the architecture in a typical layout, consisting of a router, an application gateway, network switches, and other hardware. You can trace a message throughout the network. I was the only author and used MS PowerPoint and SnipIt.

Quick Reference Guides

Elementor PDF Quick Guide

Firewall and Gateway Quick Reference Guide Diagram

JSF Web Application Server Quick Reference Guide

User Guides

AWS Project

How to Paint a Room Like a Pro Project

RCA