Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Q&A

Post History

60%
+1 −0
Q&A Breaking Into Technical Writing - Where to Start (from a programming background)

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-fac...

posted 13y ago by Monica Cellio‭  ·  last activity 5y ago by System‭

Answer
#3: Attribution notice added by user avatar System‭ · 2019-12-08T01:48:25Z (almost 5 years ago)
Source: https://writers.stackexchange.com/a/3506
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision by (deleted user) · 2019-12-08T01:48:25Z (almost 5 years ago)
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.

#1: Imported from external source by user avatar System‭ · 2011-08-02T02:00:46Z (over 13 years ago)
Original score: 10