Skip to content

Commit f910dd8

Browse files
authored
Merge pull request #297 from activus-d/getting-hired
Add article summarizing Artem’s presentation on “Get hired as a technical writer (or author)”
2 parents b26ae33 + 2b0ec89 commit f910dd8

File tree

4 files changed

+94
-0
lines changed

4 files changed

+94
-0
lines changed

website/.sphinx/.wordlist.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ Numbat
5151
observability
5252
OEM
5353
OLM
54+
PDFs
5455
Permalink
5556
pre
5657
Quickstart

website/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,7 @@
196196
"http://127.0.0.1:8000",
197197
"https://matrix.to/#/#documentation:ubuntu.com",
198198
r"https://github\.com/canonical/open-documentation-academy/commits\?author=.*",
199+
r"https://ubuntu.com/*",
199200
]
200201

201202

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Getting hired as a technical writer
2+
3+
## Presenter
4+
5+
[Artem Konev](https://www.linkedin.com/in/artemkonev/)
6+
7+
## Special thanks
8+
9+
This presentation was developed with valuable input and feedback from:
10+
11+
* [Daniele Procida](https://www.linkedin.com/in/danieleprocida/)
12+
* [Graham Morrison](https://github.com/degville)
13+
* [Giulia Zanchi](https://www.linkedin.com/in/giuliazanchi/)
14+
* [Michael Park](https://www.linkedin.com/in/michael-park-aa5aaa249/)
15+
* [Shane Crowley](https://www.linkedin.com/in/shane-crowley-a43a6a6b/)
16+
17+
---
18+
19+
<iframe width="560" height="315" src="https://www.youtube.com/embed/lAWWsq2JDt8?si=C_BgdmW9YDqmUQba" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
20+
21+
---
22+
23+
Finding a job as a technical writer can be challenging, so it’s important to view it as a project. Focus on the immediate steps, and remember it’s a marathon, not a sprint. Keep going, and never forget that in the end, you only need one successful interview process.
24+
25+
## Prerequisites for the job search
26+
27+
To be prepared for a job search, you must possess several skills, a positive attitude, a strong portfolio, and a history of community involvement.
28+
29+
### Skills
30+
31+
Your core skill is versatile writing in a professional setting. To improve at this, you should be aware of the documentation life cycle, its stages and stakeholders, and become familiar with common writing styles such as [American Psychological Association (APA)](https://www.apa.org/) and [The Chicago Manual of Style](https://www.chicagomanualofstyle.org/home.html). If English isn’t your first language, consider pursuing credible language certifications. Then practice writing outside of work through blog posts, novels, or poetry.
32+
33+
Beyond writing, a solid grasp of information architecture systems like [Diátaxis](https://diataxis.fr/) and [Information Mapping](https://informationmapping.com/) will help you organize and present information effectively.
34+
35+
You also need proficiency with technology, which comes in two forms. First, adopt a _T-shaped_ approach to knowledge, starting with general knowledge and then developing a few areas of expertise. Second, understand your writing tool stack. The two main stacks are the [Documentation as code approach](https://www.youtube.com/watch?v=AVNfH99KiME) and the [Darwin Information Typing Architecture (DITA)](https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture). Some coding knowledge helps, but it’s not a requirement.
36+
37+
Finally, soft skills are important as technical writing requires you to work with people, get your points across, and listen to others.
38+
39+
### Attitude
40+
41+
Few people know what to look for in a technical writer, so employers often focus on qualities such as excellence, leadership, initiative, and confidence. You can develop these qualities over time through volunteering and community work.
42+
43+
You must also have self-respect by not settling for jobs that undervalue your skills or that you dislike, as they will make you miserable in the long term. Technical writing is a complex, skill-intensive profession that takes years to master, so take pride in your work.
44+
45+
### Portfolio
46+
47+
You must have a portfolio of your work, with two to five diverse, complete samples ready. PDFs work well, but it’s better to display your tooling skills by hosting your portfolio on services like [GitHub Pages](https://pages.github.com/). You should also be ready to discuss the choices you made in your writing samples.
48+
49+
Beyond creating it, your portfolio should grow with you, so treat it like a garden that you care for over time.
50+
51+
### Community
52+
53+
Community involvement is a great way to understand the industry. Start by subscribing to online channels, newsletters, and podcasts. These will help you engage with experts and other writers through comments, questions, and feedback. Over time, you can become a regular participant in forums, conferences, and meetups. And remember, you don’t need to be a community champion from day one.
54+
55+
## The application phase
56+
57+
After you’ve built your skills, attitude, portfolio, and community connections, start applying for jobs. You will face rejections, but don’t let them discourage you.
58+
59+
Apply only for roles where you feel you’re a good fit, and always check the formal requirements before submitting an application. Keep in mind that the feedback cycle can be slow and it may take weeks or even months to hear back, so don’t _fall in love_ with a job until you receive a formal offer.
60+
61+
### Written submissions
62+
63+
Your resume and cover letter must be tailored to the position you are applying for. Focus on the most relevant parts of your experience and emphasise outcomes and achievements rather than responsibilities.
64+
65+
Avoid sounding desperate for the job. Instead, explain the value you bring to the company and stay truthful. Remember that your resume is also a writing sample, so check your grammar and spelling carefully before submitting.
66+
67+
### Research and preparation
68+
69+
If your application is successful, be prepared to answer questions about any claims you make on your resume. Make sure you understand the job requirements and expectations, and take time to research the company’s business, culture, and values. Review the company’s existing documentation and think about ways it could be improved, as this demonstrates your critical thinking and potential contributions. Also, look up the interviewers and prepare meaningful questions for them to show genuine interest and engagement.
70+
71+
Finally, double-check the scheduled time and be punctual. For a remote interview, confirm that your computer is working properly and that your internet connection is stable.
72+
73+
### Interviewing
74+
75+
Stay confident without being arrogant, and adapt to the interview style, whether panel or human resources. Rephrase questions when you need clarity and ask thoughtful ones that reflect your research. Then explore what it’s like to work there, and pay close attention to vague or unclear responses.
76+
77+
### Key outtake
78+
79+
Start preparing and applying now, there is no better time.
80+
81+
## Further reading and resources
82+
83+
* [NO IDEA BLOG](https://www.noidea.dog/glue)
84+
* [Write the Docs Slack](https://www.writethedocs.org/slack/)
85+
* [API The Docs](https://apithedocs.org/)
86+
* [API The Docs conference talk recordings and podcast episodes](https://www.youtube.com/channel/UCEBh-gof8_hcjXvZf2HaN_g)
87+
* [I’d Rather be Writing blog](https://idratherbewriting.com/)
88+
* [Sustain podcast](https://podcast.sustainoss.org/)
89+
* [Changelog podcast](https://changelog.com/podcast)
90+
* [University of Oxford](https://www.ox.ac.uk/sites/files/oxford/media_wysiwyg/University%20of%20Oxford%20Style%20Guide.pdf)
91+
* [Inclusive Language Guide](https://policy-practice.oxfam.org/resources/inclusive-language-guide-621487/)

website/events/community-hour-discussions/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,6 @@ You can also watch the original videos to explore the topics in depth.
1515
:maxdepth: 1
1616
1717
Documenting a new project <documenting-new-project>
18+
Getting hired as a technical writer <getting-hired>
1819
1920
```

0 commit comments

Comments
 (0)