Yearly Archives: 2018

6 posts

Using GitHub as a Technical Writer

GitHub provides a wonderful avenue for technical writers, in addition to developers. I have used GitHub internally with my company for quite a while, and it lets me track my project for any documentation issues. I like going through the email updates to see what has changed which could affect the documentation. Our documentation is sourced in a separate CMS, but I understand the GitHub workflow perfectly. Recently, I decided that I want to also utilize my skills to help […]

Coding workstation

Writing API Documentation for Developers

Who is the API Documentation Audience? When you write API documentation, you write for the API developer. When it comes to API documentation, developers focus on two things: What requests look like (you want the server to understand it) What responses look like (you want to make sense of the data) Supposed that my endpoint is located here: https://hostname:port/base/movies Simple Request I want to get a list of movies, so how do I get this result? GET /movies Simple Response […]

Chessboard

What is Content Strategy?

What exactly is “content strategy?” First, let’s define “content.” Content includes blogs, procedures, tutorials, videos, press releases, podcasts, diagrams, Swagger documentation, and so on. Second, te right content depends on what our audience really needs. Content strategy is the development, planning, and execution of content for that audience. Users want the best content, and we want them to find and use this content easily. We are living in a world that demands quick, accessible content. The audience probably uses Google […]

New STC Awards for Technical Documentation!

I received two Society for Technical Communication (STC) awards this year! STC Award for Installation Content My CA Mainframe Operational Intelligence installation content¬†received an STC Award of Excellence. This product requires a complex mainframe environment, so the content strategy provides a phased approach. Customers might have different roles at varying stages of the installation, so I want them to understand each phase correctly. First, you set up your environment prerequisites, like a “site prep.” Second, you go through the main […]

How I Write and Edit Technical Documentation

I have extensive experience in both writing from scratch or editing existing content. When I write content from scratch, I take a deeper dive into the audience analysis. I want to know the what, how, and why. It lets me understand the role and I can create the appropriate content for that user. I also validate the content as much as possible. In the process of validating content, you will discover ways of improving your products! Creating or editing The […]