XSL-FO

Now trending: http://www.w3schools.com/xslfo/. XML Formatting Objects is what I'm currently studying.

10+ Skills a Tech Writer Must Have

(Inspired by this article: 10 Skills Developers Should Invest In for 2014.)

I'm a tech writing project manager, so this is just my two eurocents' worth. An actual writer or a manager may have and probably does have a different idea of what consists a basic competence set. I work mostly with projects in the IT business, and with a combination of resource hire and "full" projects.

So, in no particular order, here are the 10+ big things I expect any tech writer to be able to handle:

1. English

You have to be able to speak and write grammatically correct English. This is basic requirement #1. Sorry. Most companies in Finland write their products and their documentation in English even if their corporate language is Finnish, mostly to keep down localisation costs. Otherwise, not only are you forced to translate from FIN to ENG when you stick a toe outside the border, but translating from Finnish into any other language is more costly than using English as your source language.

It also helps if you can draw on extensive knowledge of orthography and grammar to justify yourself to SMEs who think they know English but don't ;)

2. Information Design

You have to know how to structure a document from scratch. Not many projects you work on will require this, but it's a basic qualification that falls under the heading of "know how to write".

If you can't do ID, then you always have to have someone else plan your documents for you, and it limits the type of project you can do.

3. HTML and CSS

You have to know at least the basics of how they work and be able to edit raw HTML. Bonus points for being able to build a site from scratch.

4. XML and DITA/DocBook basics

Know how XML works and why. Most documentation today already happens in XML in some way, or if not XML then some other structured language. DITA and DocBook are the most frequently used architectures in technical communication.

5. Use Microsoft Word in a way that doesn't break things

Word is to tech writing what boiling potatoes is to cooking. 

Know how to use and troubleshoot styles, cross-references, TOCs, images, and numbered and bulleted lists, to name just a few. You have to know better than to use direct formatting in anything but the most throwaway of docs.

You should also have an understanding of what is determined by the template and what is not, and how it's done. Bonus points for being able to create usable templates from scratch.

6. Have the basics of at least 3 authoring tools apart from Word

FrameMaker, RoboHelp, Doc-to-Help, Author-It, Madcap Flare, oXygen, Arbortext, Serna, XMLmind... Take your pick, but know at least the basic functionalities and requirements of some of the above. I don't mind whether they're help authoring tools or document authoring tools, XML or proprietary, just know a good selection.

7. Edit images

Know your way around image editing software. You have to be able to crop images, add callouts to pictures, draw flow charts, edit vector and line drawings and convert images from one format to another. 

8. Do work estimates

Have at least some idea of how long it takes you to complete a task from start to finish. This takes some practice but has not just professional but also personal payoffs. Bonus points if you're correct to within 10%.

9. Ask stupid questions

You can't be afraid to sound like a total newbie in front of SMEs. Especially in more arcane business areas this is frequently the case, and it's totally okay! If you knew the programmer's job, then that would be your profession, not tech writing. Know your strengths and don't be afraid to show your weaknesses.

It's a lot less embarrassing to ask a question up front than it is to submit a completely clueless first (or second, or final) draft!

Also, at the end of the day, you are not responsible for the technical accuracy of your docs, the SMEs are.

10. Use Google (+ other info resources)

Know how to phrase searches effectively and how to find the needle of information in the haystack of search results. Know how to evaluate the quality of sites from how they show up in the results. Know where to find additional information... and when to stop searching and start thinking and writing.

+ Writing

Communicate easily in writing, write texts at the drop of a hat in different registers for different audiences. Be able to adjust the tone, difficulty level, viewpoint etc. of any text, not just your own. Write all the friggin' time just because it's what you do.

What do you think are the basic qualifications for a tech writer? Write them in the comments!