ArtsAutosBooksBusinessEducationEntertainmentFamilyFashionFoodGamesGenderHealthHolidaysHomeHubPagesPersonal FinancePetsPoliticsReligionSportsTechnologyTravel

Essential Skills for Technical Writers

Updated on November 3, 2010

Getting Started in Technical Writing

If you are a new or aspiring technical writer, you've chosen a profession that is in demand, interesting, and rewarding for many personality types. Yet you might still have questions, such as 'What skills do I need to do well?' or 'What knowledge do I already have that I can use in tech writing?' In this article I discuss some of the things that I wish I had known when i first started out.

I have experience in software documentation, so this article may be most relevant to technical writing in that field; however, you may find it applicable to other fields and types of writing, particularly the section on Transferable Skills.

Writing Well is Just the Foundation

Let's debunk a myth about tech writing: having the ability to write a newspaper article or a haiku is no guarantee of similar success as a technical writer. Technical writing requires specific skills, of which a solid grasp of the mechanics of English is just one aspect.

Most technical writing positions require a degree in English or a related discipline; however, some technical writing jobs may also require a science degree (Computer Science, Engineering, etc.). These technical writing jobs are not as plentiful as those that require only a writing background, but writers who have both a science degree and a proven ability to write well are often able to command a competitive salary because they possess a rare combination of skills.

In addition to a science or technical degree, experience that would look good on a technical writer's resume are fluency in foreign languages, technical experience, and certifications in writing or fields such as project management. In other words, it's not just about the writing! With their varied backgrounds and interests, technical writers bring a wealth of insight and knowledge to their work.

Tools for Technical Communication

To keep content consistent and in accordance with corporate and legal policies, most companies have in-house style guides, which both writers and editors must use. Companies may also refer to reputable sources such as The Chicago Manual of Style or The Microsoft Manual of Style for Technical Publications. In recognising a need for a style guide for web-based writing, Yahoo! published a style guide for web content in July 2010.

In addition to making sure that editorial aspect of their writing is up to speed, technical writers often need to be up-to-date with the programs and technical skills they use. The following are some examples of skills and programs used in software documented, with links to online tutorials where appropriate:

Much depends on the field that writers work in, and also the company's processes, but as a general rule, technical writers would do well to be well-versed in different types of authoring tools.

Transferable Skills

As important as your writing skills and knowledge about authoring tools are, the key to being a great technical writer is having certain transferable skills. A successful technical writer can:

  • Work well independently and with others. Most of us are probably better at one than the other, but it pays to be at least comfortable with both. A technical writer usually spends much of the workday in front of a computer writing, reading, and thinking. The rest of the time, the writer may be meeting or interviewing subject matter experts (SMEs) for information.
  • Be organised. Writing is fundamentally about communicating ideas. Have you ever read a document--whether a user guide, an essay, or a news article--that was confusing or unclear? Chances are, a befuddling piece of writing is a sign of a befuddled writer. If you can't organise your thoughts and turn them into a coherent document, your writing (and your intended audience) will suffer for it. If it's a question of not understanding a certain concept well enough to write about it--ask the subject matter experts! (See point below, "Be a charmer".)
  • Be adaptable. No software, product, or industry is static. This means you have to be willing to keep up to date with whatever upgrades and new features are made in the product you support. Perhaps more importantly, you must be able to adapt to changes in company practices. Often, major changes are driven by technological advances. Some of the changes that I've experienced as a technical writer are: a transition from writing in XML to using an authoring tool by Consona; incorporating DITA for software documentation; and augmenting user guides in PDF format with wiki-based content.
  • Be a charmer. Well, not quite. But interpersonal skills are a must. Technical writers have to able to get what they need from subject matter experts. Getting timely information is often a major obstacle for technical writers, who may have to deal with engineers, project managers, programmers, and others who either are too busy for you or don't see the value in getting involved with documentation. You have to be persistent and let the other party see the 'big picture' about why their involvement is important.

 

Technical Writing and Beyond

At the beginning of this article, I alluded to the fact that there is no one ideal personality type suited to technical writing; different personalities can bring valuable insights to a documentation team. It's also true that with the experience you acquire from working on different projects, with different SMEs, and eventually, with different employers, you can become a better technical writer--and also a more employable one.

As you progress in your career, you might want to make a transition into a related field--such as technical editing, knowledge management, or communications--or you might find it rewarding to do something completely unrelated. Wherever your career takes you (or has taken you), working as a technical writer is engaging, dynamic, and can help you achieve your professional goals.

Comments

    0 of 8192 characters used
    Post Comment

    • profile image

      Heidy Vargas 

      3 years ago

      I found your hub to be a very informative one about technical writing, which is a field I have always been interested in.

    • profile image

      noman 

      5 years ago

      really fruitful site for students

    • creativegenius profile image

      Brian Scott 

      5 years ago from United States

      Thanks for adding the useful resources and tools that tech writers use.

    • ShaamCA profile image

      ShaamCA 

      6 years ago from India

      Thanks for sharing the guides.its very useful.

    • htodd profile image

      htodd 

      6 years ago from United States

      w3schools is really nice ...Thanks for telling this awesome website

    working

    This website uses cookies

    As a user in the EEA, your approval is needed on a few things. To provide a better website experience, hubpages.com uses cookies (and other similar technologies) and may collect, process, and share personal data. Please choose which areas of our service you consent to our doing so.

    For more information on managing or withdrawing consents and how we handle data, visit our Privacy Policy at: https://hubpages.com/privacy-policy#gdpr

    Show Details
    Necessary
    HubPages Device IDThis is used to identify particular browsers or devices when the access the service, and is used for security reasons.
    LoginThis is necessary to sign in to the HubPages Service.
    Google RecaptchaThis is used to prevent bots and spam. (Privacy Policy)
    AkismetThis is used to detect comment spam. (Privacy Policy)
    HubPages Google AnalyticsThis is used to provide data on traffic to our website, all personally identifyable data is anonymized. (Privacy Policy)
    HubPages Traffic PixelThis is used to collect data on traffic to articles and other pages on our site. Unless you are signed in to a HubPages account, all personally identifiable information is anonymized.
    Amazon Web ServicesThis is a cloud services platform that we used to host our service. (Privacy Policy)
    CloudflareThis is a cloud CDN service that we use to efficiently deliver files required for our service to operate such as javascript, cascading style sheets, images, and videos. (Privacy Policy)
    Google Hosted LibrariesJavascript software libraries such as jQuery are loaded at endpoints on the googleapis.com or gstatic.com domains, for performance and efficiency reasons. (Privacy Policy)
    Features
    Google Custom SearchThis is feature allows you to search the site. (Privacy Policy)
    Google MapsSome articles have Google Maps embedded in them. (Privacy Policy)
    Google ChartsThis is used to display charts and graphs on articles and the author center. (Privacy Policy)
    Google AdSense Host APIThis service allows you to sign up for or associate a Google AdSense account with HubPages, so that you can earn money from ads on your articles. No data is shared unless you engage with this feature. (Privacy Policy)
    Google YouTubeSome articles have YouTube videos embedded in them. (Privacy Policy)
    VimeoSome articles have Vimeo videos embedded in them. (Privacy Policy)
    PaypalThis is used for a registered author who enrolls in the HubPages Earnings program and requests to be paid via PayPal. No data is shared with Paypal unless you engage with this feature. (Privacy Policy)
    Facebook LoginYou can use this to streamline signing up for, or signing in to your Hubpages account. No data is shared with Facebook unless you engage with this feature. (Privacy Policy)
    MavenThis supports the Maven widget and search functionality. (Privacy Policy)
    Marketing
    Google AdSenseThis is an ad network. (Privacy Policy)
    Google DoubleClickGoogle provides ad serving technology and runs an ad network. (Privacy Policy)
    Index ExchangeThis is an ad network. (Privacy Policy)
    SovrnThis is an ad network. (Privacy Policy)
    Facebook AdsThis is an ad network. (Privacy Policy)
    Amazon Unified Ad MarketplaceThis is an ad network. (Privacy Policy)
    AppNexusThis is an ad network. (Privacy Policy)
    OpenxThis is an ad network. (Privacy Policy)
    Rubicon ProjectThis is an ad network. (Privacy Policy)
    TripleLiftThis is an ad network. (Privacy Policy)
    Say MediaWe partner with Say Media to deliver ad campaigns on our sites. (Privacy Policy)
    Remarketing PixelsWe may use remarketing pixels from advertising networks such as Google AdWords, Bing Ads, and Facebook in order to advertise the HubPages Service to people that have visited our sites.
    Conversion Tracking PixelsWe may use conversion tracking pixels from advertising networks such as Google AdWords, Bing Ads, and Facebook in order to identify when an advertisement has successfully resulted in the desired action, such as signing up for the HubPages Service or publishing an article on the HubPages Service.
    Statistics
    Author Google AnalyticsThis is used to provide traffic data and reports to the authors of articles on the HubPages Service. (Privacy Policy)
    ComscoreComScore is a media measurement and analytics company providing marketing data and analytics to enterprises, media and advertising agencies, and publishers. Non-consent will result in ComScore only processing obfuscated personal data. (Privacy Policy)
    Amazon Tracking PixelSome articles display amazon products as part of the Amazon Affiliate program, this pixel provides traffic statistics for those products (Privacy Policy)