Writing for the Web | Olga Kostiouchina

Writing for the Web

by Olga Kostiouchina

“Content is king” as the old (or not so old) adage goes, and many technical writers choose to specialize in creating content for the web.


Indeed, as the web has become a major information resource for anyone who uses it, many of us turn our heads to it in hopes to contribute and make a living at the same time.


What do you need to know and do to become a web writer:


Ground rules! Writing for the web is different from writing for print. Review the “Writing for the Web” course that was part of the Technical Writing program at BCIT to freshen up your knowledge. In addition, check out the multitude of resources on the web that explain the best practices for web writers.


Keep a blog.
Blogging is not a new phenomenon any longer, it’s a huge online force that keeps people with similar interests connected. If you keep an interesting blog and contribute regularly, you will be found, linked to, may become popular, or even go viral! This will increase your exposure as a specialist (if you position yourself as one), will improve your writing skills, promote these improved skills, can become part of your writing portfolio and much more.


Comment on other blogs.
To further increase the exposure and speed up your blog’s popularity growth, be sure to find other bloggers (people or businesses), who have interests in the same areas as you, make thoughtful comments and include a link to your own blog, too.


Use social media tools.
Facebook, Twitter, LinkedIn and many more tools available for socializing through the web also provide excellent networking opportunities. If you’re active in social media you immediately position yourself as web savvy.


Learn about SEO.
Since  web writing goes hand in hand with marketing, it’s very likely that whoever hires you to write web copy will be looking for content that promotes their business on the web. And you can’t promote anything on the web without at least a basic idea of Search Engine Optimization. Take out a good book from the library, find Internet resources, you’ll be ahead of the crowd if you add SEO knowledge to your skill set.


Learn HTML/CSS.
If you become a web writer, there’s a good chance you’ll have to upload and format the content yourself. Therefore, some knowledge of main front-end web development tools will come in handy. Take an introductory web development course and you’ll be on your way. Practice using the new skills to become more confident and creative.

Copyright ©  June 2011 || Olga Kostiouchina

Vancouver, British Columbia

Editor: Jacob De Camillis

Business Writing | Olga Kostiouchina

Business Writing

by Olga Kostiouchina

A technical writer is often called to the duty of writing many business related documents for companies. By creating a comprehensive set of documentation that describes and assists in every aspect of the business a technical writer does an invaluable service to the company. As a result the business runs more efficiently, all processes are handled on a highly professional level, eliminating miscommunication between departments and increasing productivity.

If you acquire skills in this area of specialization, almost any business can benefit from hiring you.

What do you need to know to become a business writer?

It’s good if you have general knowledge of how businesses operate, however, no business degree is required. If you’re not confident, a couple of specific courses could help you get some pointers in the right direction. Some available and very useful courses at BCIT will teach you the basics of marketing and business operations, rules of business correspondence, writing proposals and much more. You might want to look into the document control processes as well, specialists in this area are hard to come by. Interdepartmental communication plays a vital role in how smooth the business runs, and document control is one of the main ways to improve it.

What are the examples of business writing?

Business documentation can include anything that directly relates to how the business is run:

• Letters
• Business and grant proposals
• Reports
• Meeting minutes
• Business plans
• Operation manuals
• Policies
• Procedures
• Templates
• Training materials
• Process descriptions
• Various flowcharts and graphs
• Annual reports

How can you improve your portfolio in order to apply for a business writing position?

If you have a job, try writing the procedures and policies you’re familiar with from scratch. Create a few graphics that show the processes used in the business.
If you’re unemployed approach a business, such as a non-profit organization, and offer to write documentation on a pro bono basis or for a small fee.

If you took a course in Proposal writing - include academic samples from that course.
If you’re self-employed, you’re bound to have some procedures in place on how you run your own business. If they’re not in the form of existing documents and templates -  it’s time to put them in writing now!

You’ll gather enough samples to include and show off the skills you possess when applying for that a job.

Further reading and resources:
http://www.lupinworks.com/roche/index.php : lots of good concise advice both on technical and business writing best practices

http://www.prismnet.com/~hcexres/textbook/acctoc.html : an excellent educational resource on technical and business writing with many examples

http://www.amazon.com/Power-Tools-Technical-Communication-McMurrey/dp/0155068989/ref=sr_1_1?ie=UTF8&qid=1307464601&sr=8-1 : an enhanced textbook version of the above resource by the same author

Copyright ©  June 2011 || Olga Kostiouchina

Vancouver, British Columbia

Editor: Jacob De Camillis

Writing for Information Technology | Olga Kostiouchina

Writing for IT

by Olga Kostiouchina

The continued rapid development of the software industry prompts the creation of many positions for technical writers. Writing for IT is probably what the vast majority of technical writers does. They document the software, create API for programmers, often serving as liaison between the developers and end users.

What do you need to know for specializing in IT:

You don’t need a degree in Computer Science to start writing for an IT company; however, there are a few useful things you could learn to improve your chances of landing a job and do better in this field.

Take some courses in web development; many employers require experience with HTML authoring.

Get acquainted with some of the more popular programming languages as well as databases; job descriptions often list the ability to understand the source code and create database queries as an essential and required skill.

Knowledge of XML is especially useful and not just for working in an IT company, it’s essential for structured authoring, single-sourcing and using such technologies as DITA for creating a broad range of documents from a single master document.

You can learn all this part-time at BCIT. You can also learn on your own using books and online videos.

Oftentimes the programmers use the auto-generated documentation which you as a technical writer would have to clean up, organize and bring it to its final publishing stage.

The specific knowledge will help you better understand your SMEs and decipher whatever documentation may have been already created in the software development process.

What can you expect to write in IT industry:
Here’s a sampler of what kind of documentation you may be creating as an IT technical writer:

• Installation guides
• User guides
• Quick and thorough reference guides
• Troubleshooting guides
• Online help
• Glossaries
• APIs  (Application Programming Interface)
• Training modules
• Various manuals for end users, system administrators or technical support stuff
• Marketing materials explaining what exactly the software does

If you decide that writing for software industry is your cup of tea, make sure you include appropriate samples in your portfolio. Pick an open source software program and try to create as many documents from the list above as you can. If the software is complex, pick a few aspects that you can document thoroughly, and include something like a quick reference guide.

The usual rules for technical writers apply and are strongly encouraged: consistent terminology, concise language, usage of style guides.

Copyright ©  June 2011 || Olga Kostiouchina

Vancouver, British Columbia

Editor: Jacob De Camillis

Writing for Engineers | Olga Kostiouchina

Writing for Engineers

by Olga Kostiouchina

No doubt heavy industries are big here in BC. It’s good if you have an engineering degree and transition to technical writing. But what if you’re not so lucky? Can you still write for engineers?

Engineers' job duties often include a lot of writing. However, not every engineer can do this well, that where technical writers come in and take over.

What if you don’t have the engineering or other technical degree? Can you still break into engineering writing field?

The answer is yes! You have to have a strong technical aptitude and like going into the depths of how things work. You have to be able to grasp the technical and mechanical concepts and learn the terminology quickly.

To help you get a better understanding of all sorts of mechanics, you might want to take a few classes and learn at least the basics. For example, BCIT now offers a few engineering and technical programs on a part-time basis, which means you don’t have to sign up for the entire program;  taking a few courses in your areas of interest will help you get up to speed and start talking the same language engineers do. Try also learning the basics of AutoCAD  - many job ads for technical writers require the knowledge of this drafting software, but even if not – you’ll be much better off knowing how to manipulate the graphics for engineering.  

Of course it’s great to demonstrate your knowledge when applying for the job, but it can be trying to absorb and retain the highly technical information without putting it to regular use. So here’s  the caveat before you dive into all this learning -  if you find a job in the engineering company quickly – learn as you go.

What kind of documentation can you expect to write in the industrial company?

Engineers write such documents as:

·         Business correspondence (letters and memos)

·         Reports (design, laboratory, progress),

·         Proposals

·         Instructions

·         Specifications

·         Training materials

You can expect to author many of the similar documents, based on information you gather form interviewing engineers; you may also help develop presentations and create all kinds of graphics.

Pick up a book and find out what’s involved in writing as an engineer.

Further reading and resources:

http://www.amazon.com/Guide-Writing-as-Engineer/dp/0470417013/ref=sr_1_1?s=books&ie=UTF8&qid=1306785479&sr=1-1 – highly recommended by engineers, this volume provides guidance with many examples

http://www.writing.engr.psu.edu/index.html - useful educational resource on writing guidelines for engineering and scientific students

Copyright © 2011 || Olga Kostiouchina

Vancouver, British Columbia

Editor: Jacob De Camillis

Alistair Henry: BCIT Tech Writing Grad -- Where is he now?

|Tech Writing Grad Profile|

Alistair Henry

I graduated from BCIT's technical writing program in the spring of 2008 and immediately moved to Amsterdam in the Netherlands. Upon arriving, I found a job with an IT recruitment firm where I was responsible for writing enticing job descriptions and formatting highly technical resumes. Having partnered with a Franchise Consultant for my major project prior to graduating, I continued working for him remotely. I wrote and assembled policy & procedure manuals and edited the work his other writers produced. I was also privileged enough to get a contract with an online radio station where I created how-to guides for their broadcasters.

I moved to the UK and in 2010 I decided to continue with my education. I was able to enter into a Master's program without having an undergraduate degree as I was given credit for my Associate's Certificate from BCIT. Now I am one year into my two year degree and find I have an advantage over my younger colleagues; writing essays, papers and critical commentaries comes easily to me.

I am in the process of migrating my career toward my passion; the subject of website usability. This was spawned by my technical writing experience as both require the ability to see through the eyes of the end user; to be an advocate. Next year I will graduate with an MSc in Creative Technologies with a specialization in usability & ergonomics. I am already doing some freelance website usability work for another university and for the National Health Service. I feel my technical writing education and experience played an integral role in sending me down the path I am currently on.

-- 

Alistair Henry

www.allstaryvr@blogspot.com

Medical Writing | Olga Kostiouchina

Medical Writing

by Olga Kostiouchina

Medical writing is a great career choice for technical writers who have studied medical sciences before, such as biology, anatomy or pharmaceutical sciences.

What do medical writers do?

Medical writers develop documentation about drugs, medicine, health and related technology. Some of the materials a medical writer may be creating are: articles for health care professionals, medical research grant proposals, training and marketing materials for pharmaceutical industry, patient education materials which may include brochures, flyers news articles, both for print and web. There are many more various documents that medical writers create;  it’s a broad field where you can apply your skills and make a good living.

What if you don’t have a degree in medicine or the sciences?

You can still develop a successful career as a medical writer! Enroll in some basic courses, such as Medical Terminology, Anatomy 101, or join the professional association which may provide a lot of necessary training. Professional association in US called AMWA (American Medical Writer’s Association) has a great website with lots of training and certification courses you may take if you’re a member. If you want to try your ambitions in Europe, they have their own membership association that offers courses in medical writing – EMWA. Both associations have job boards as well.

Salary and Outlook for Medical Writers

According to many sources the absolute majority of medical writers are very satisfied with the money they make. You can expect a pretty high entry level salary, especially if you have a degree in science or health care. What’s more, the employment prospects are growing all around the world, which means that the outlook for those entering the medical communication field is very good.

Looking for work

Network! Attend medical conferences, join professional associations and web communities, research the local industry – medical or pharmaceutical. Start or update your LinkedIn profile by listing your new skills and joining professional groups that often have job boards. Participate actively in discussions held by the groups you’ve joined. Create or update your website. Add medical writing pieces to your portfolio. To do this try contacting many non-profit organizations dealing with health care issues and offer some pro bono work. You may end up getting employed!

Further reading and resources:

http://www.amazon.com/dp/0813812534?tag=mediwrit-20&camp=14573&creative=327641&linkCode=as1&creativeASIN=0813812534&adid=0WG5BY8E3CTY3S23H5YK&  : An excellent guide for present and future health writers

http://www.amwa.org/default.asp?id=1  : American Medical Writers Association

http://www.emwa.org/Home.html  : European Medical Writers Association

http://medicalwriter.blogspot.com/  : A resource-rich Canadian blog maintained by medical writers.

http://intercom.stc.org/2011/05/medical-writing-and-editing-opportunities-for-the-independent-consultant-or-contractor/  : A success story article from the current (May 2011 issue) of STC Intercom publication – accessible without STC membership.

Copyright © 2011 || Olga Kostiouchina

Vancouver, British Columbia

Editor: Jacob De Camillis

Instructional Design | Olga Kostiouchina

Instructional Design

by Olga Kostiouchina

Whether or not you have a background in education, you as a technical writer may often find yourself in the shoes of an instructional designer.

What is instructional design?

Here’s a dictionary definition:

"It is the process by which instruction is improved through the analysis of learning needs and systematic development of learning materials. Instructional designers often use technology and multimedia as tools to enhance instruction."

In other words, every time you sign up for creating a training manual or an e-learning course, you effectively become an instructional designer and perform all the tasks commonly associated with this occupation: research of the topic you’re supposed to write about, analyze the needs of the proposed user and design the material according to these needs.

What credentials you may need?

There are instructional design academic programs out there, and there’s a lot to be said on how complex the process of designing the training materials can get, but don’t despair! You may grow to be an excellent instructional designer and be able to create high quality training materials if you have the right aptitude and desire to succeed even without an advanced degree. Of course instructional design is a science in itself with its theory, methods and models, so be sure to read up and take some courses that will help you master at least the basics. There are courses at UBC within the Master of Educational Technology program, this program is broken down into 2 certificate programs, so you can chose to take one, or the other, or both for your Master’s degree. They’re taught completely online, can be taken at your own convenience, the only catch is – you have to have at least a Bachelor’s degree to be accepted into the program.

Software that is good to know:

Certainly you will need to know the usual authoring tools, but one advantage you can definitely gain is by learning screen and video capturing tools for e-learning such as Adobe Captivate or Camtasia Studio. Another group of e-learning authoring tools widely used by instructional designers is made by Articulate and includes the following titles: Presenter, Quizmaker, Engage and Articulate Online. Instructional design goes hand in hand with usability experience and GUI (Graphic User Interface) development, so knowledge of web development  and computer graphics software is exceptionally useful as well.

Further reading and resources:

http://www.stcsig.org/idl/resources__info.shtml : STC’s Special Interest Group  (SIG) excellent collection of links related to instructional design.

http://www.instructionaldesign.org/ : A website kept up by notable instructional and learning professionals.

http://met.ubc.ca/ : UBC Master of Educational Technology homepage.

http://intercom.stc.org/2011/05/you-may-be-an-instructional-designer/ : An article from the current issue of STC Intercom publication – accessible without STC membership.

Copyright © 2011 || Olga Kostiouchina

Vancouver, British Columbia

Editor: Jacob De Camillis