Tuesday, April 3, 2018

career - Breaking Into Technical Writing - Where to Start (from a programming background)


I'm currently in the process of expanding my company from doing coding & web development to more technical writing and freelance tech journalism. Although my background is mainly in technology, throughout high school and college I put a few AP and advanced writing courses under my belt and I've gotten fairly familiar with business correspondence, and while I've done some basic instruction sets for clients, I've never had a part-time or full-time position just for writing.


At the moment I've been searching career sites and reaching out to my network of contacts, however aside from those measures, is there any thing else I should be doing? For example, although I have a blog containing articles I've done, should I also assemble a portfolio of mock proposals and correspondence to show my knowledge?


Thanks very much in advance for any suggestions,



Answer



There are different kinds of technical writing, differing in the "technical" part. The logical place for you to start, coming from a programming background like I did, would be with programmer-facing documentation: APIs, SDKs, and the tutorials and guides that go with them.


If any of your current (programming) work could benefit from either external (interface) or internal (design, architecture) documentation, you could start there to build your skills and portfolio (and maybe your first gig). Failing that, instead of doing mock work to show what you can do, why not do real work for the open-source project of your choice? That may also help you with the networking; when you contribute valuable documentation to Project Whatever, then (1) your stuff gets seen and (2) the other people working on Project Whatever might help you find paying gigs.


You can also go the professional-association route. STC (Society for Technical Communicators) is the common one, but it's a broad base -- you'll find some programming writers there, but also a bunch of people documenting UIs, hardware, and -- surprise :-) -- non-software products like medical and engineering devices. So it's a broad group, and how deep it is depends on the folks in your local chapter. I gave a talk on API documentation at a regional STC conference a while back and it was the only programming-related topic on the docket; however, a few years later at the national conference there were more options. It varies. I'm not currently a member of STC so I don't have the current sense of it. I found more value in the documentation SIGs of ACM and IEEE, though I've also let those memberships lapse. (Sorry, just lazy I guess. :-) )


Breaking into any new field has two key parts: demonstrating good skills and finding the right people to demonstrate them to. If you can ease into it in your current position then you have a leg up; you already know the people. If not, you have to build a body of work and do some networking.


No comments:

Post a Comment

technique - How credible is wikipedia?

I understand that this question relates more to wikipedia than it does writing but... If I was going to use wikipedia for a source for a res...