Technical Writing

While creativity, flexibility, and storytelling are necessary skills for technical writers, technical writing is not creative writing. In other words, readers of technical writing are not seeking to be entertained but to get information quickly and easily. Therefore, technical writers must learn to communicate complex ideas simply and clearly. This article will briefly cover the principles of correctness, characters, and actions as taught by Joseph M. Williams in Style: Lessons in Clarity and Grace.  

While creativity, flexibility, and storytelling are necessary skills for technical writers, technical writing is not creative writing. In other words, readers of technical writing are not seeking entertainment but to get information quickly and easily. Therefore, technical writers must learn to communicate complex ideas simply and clearly. This article will briefly cover principles of cohesion, coherence, and emphasis as taught by Joseph M. Williams in Style: Lessons in Clarity and Grace.

While creativity, flexibility, and storytelling are necessary skills for technical writers, technical writing is not creative writing. In other words, readers of technical writing are not seeking entertainment but to get information quickly and easily. Therefore, technical writers must learn to communicate complex ideas simply and clearly. This article will briefly cover the principles of word choice and concision as taught by Joseph M. Williams in Style: Lessons in Clarity and Grace.

Congratulations, you’re starting a project! Starting a project as a technical writer might seem daunting, but don’t worry, you’ll get the hang of it in no time. This document aims to serve as an aide to you as you start a new project. Maybe you have extensive experience in project work, or maybe this is your first time. Either way, that’s ok! We are here to help regardless of your experience level, and as always, never be afraid to ask questions to your supervisor and fellow technical writers. With that being said, let’s talk about how to start a project!

Picture this: you’re standing behind a stage waiting for your turn to give a hilarious, knee-slapping stand-up comedy bit. Since the stage is inside a high school auditorium, you assume your audience will consist of grungy, bored teenagers. You've diligently researched and prepared an action-packed bit full of colorful stories and funny noises. As your turn is announced, you confidently walk on the stage, ready to blow the audience away and earn their respect. The curtain opens, exposing the many eyes on you. Your jaw drops. Instead of seeing a bunch of restless teenagers, you’re faced with a large group of older folks, and I mean OLDER folks. In the front row, there’s a sweet old lady wearing a shirt with a local nursing home name on it. The group sits patiently, waiting for you to begin.

In both UX writing and Technical Writing, you will need to conduct interviews with people who devote their time to a specific system or application. We call them subject matter experts or SMEs.

As an OIT Technical Writer for the UX team, your role includes a hybrid of technical and UX Writing. This hybrid of skills and training makes you uniquely qualified for a variety of writing projects and positions.

Documentation is essential for maintaining a successful organization. Furthermore, clean, organized documentation is ideal for clear communication and essential for well-maintained software and technical systems.