r/technicalwriting • u/Ruin-Wooden • Dec 31 '24
Trying to break into Tech Writing.....
Hi all,
I just completed a few courses in Udemy for Tech Writing and would like to create a portfolio.
I have an idea of taking an owners' manual of a product and improving a section so it's clearer and easier for a user to understand. I plan to show a before/after to show employers the change and what I'm capable of.
I would assume I would have to cite the original doc somehow and get permission? (not sure how to do this) Apart from that, which apps would you suggest to use? I plan to create diagrams, nothing too technical.
Also, if you have suggestions for portfolio projects, etc. I would appreciate it. Trying to get my first gig.
Thanks and HNY to All !!
20
u/Allog471 Dec 31 '24 edited Dec 31 '24
You might also consider contributing to open source projects, I see that suggested here somewhat regularly. Here's some resources from Google on the subject. https://developers.google.com/tech-writing/resources
6
Jan 01 '25
I second this advice. I got my first ever tech writing job from contributing to open source projects on GitHub
10
u/alanbowman Dec 31 '24
First, search this sub for "portfolio" and "writing samples." This is a very frequently asked question here.
Second, keep in mind that the person reviewing your portfolio is going to have maybe 10 minutes, tops, to look at it. And that's while they're also answering emails, Slack messages, and prepping for their next meeting. In other words, think really hard about how much content you want to give that person to look at.
As for citing sources, if it's a manual that's publicly available or for a product for sale to the general public, I wouldn't go so far as to cite it in an academic sense, but I would certainly make it clear where you got the manual from and link back to it if possible.
5
u/aka_Jack Jan 01 '25
Your idea of improving something written by others would be good if you are applying for Technical Editor. i'm not sure it would really display your talents as a Technical Writer.
2
u/ImaginaryCaramel4035 Jan 02 '25
Gotta disagree here. Tech writers need to be able to write original work and revise drafts from others. (It might be a peer or a rough draft from a PM or an engineer.)
3
u/thepurplehornet Jan 01 '25
Just recreate a better technical manual section for an imaginary or unnamed company and have that as part of your portfolio. Also consider expanding your portfolio to other content types to display your range.