Technical Writing Weekly
Dear writers community 👋!
I hope the week has been productive. Before you start reading, tell your friends about this newsletter by tweeting, sharing, and forwarding using #Technicalwritingnewsletter. Tag @joklinztech on Twitter.
WRITING TIPS ✍🏿
This is my short story about how I was paid over $990 to build a doc site.
I saw a technical contract writing gig on Linkedin with the following information:
Jobe title: Technical writing contract
Role: Freelance
Country: United State
In the JD, they didn't mention anything like remote worldwide or remote everywhere, which didn't discourage me from applying.
Why did I do that? I remember once a recruiter told me that when they post jobs on LinkedIn, they don't have the option to put worldwide,
So they mostly post the company's location.
I had that belief and applied; I got an invite for the first interview the next day.
One key thing I did was to read through the JD to find what they want from a candidate.
I saw they needed somebody with experience building docs sites using Hugo and API doc design using Postman.
I quickly created a sample doc site using postman and designed an API doc using postman.
During the interview, I paused her for a few minutes to share my samples and noticed she was happy with them.
She was supposed to have another call with me on the technical side of the project, but I got the job on the first call.
Note: She only asked me a few questions because of the sample I shared on the call.
I got my hand on their interview questions for applicants.
1. What is your experience with technical writing
2. Have you built a doc site before
3. Why should we hire you?
4. Do you have experience with API documentation?
5. What other skills do you have?
JOBS 👩💻
Technical Writer at QuickNode
Fulltime, Remote
As a Technical Writer at QuickNode, you will be responsible for creating high-quality instructional guides and tutorials on Web3 fundamentals and various blockchain technologies, which will be featured on QuickNode's Guides page (https://www.quicknode.com/guides/) and other areas of the website.
👉🏿 Apply Now
Senior Technical Writer at Grafanalabs
Fulltime, Remote
We are looking for a Technical Writer to produce high-quality documentation and guides for Grafana Labs. You will collaborate with the engineers, product managers, and the Grafana writing team to produce a variety of tailored content to ensure our products are easy to learn and rapidly adopted.
👉🏿 Apply Now
Senior Technical Writer at Deel
Fulltime, Remote
Deel is looking for a Lead Technical Writer to join the Knowledge Team. Are you a word nerd who loves to explain complex concepts in simple language? Can you spot ambiguities and logical inconsistencies from a mile away? Do you get a kick out of style guides and know when to follow the rules and when to break them? If so, this role might be for you.
👉🏿 Apply Now
Editor/Content Producer at Gnosis Builders
Fulltime - Remote
We’re seeking a content producer to produce content for press releases, blogs, and other external communication tools
Manage and produce content for the internal wiki and
Support building up communication strategies across platforms
Support other marketing initiatives
👉🏿 Apply Now
Technical Content Writer at 5ire Blockchain DMCC
Fulltime, Remote
5ire is a blockchain company whose mission is to make blockchain sustainable and accessible for over one billion people by 2030. The company aims to address the problem of low blockchain adoption due to sustainability and accessibility challenges.
👉🏿 Apply Now
Freelance writer at Miller Ink
Freelance, Remote
Miller Ink is looking for skilled freelance writers to join our writing department on a per-assignment, contract basis. When applicable, freelance writers will work with Miller Ink staff to draft long-form written content—including op-eds, feature stories, blog posts, video scripts, white papers, and more—to support the firm’s client work.
👉🏿 Apply Now
EVENTS 📆
TECHNICAL WRITING RESOURCES 📚 + 💻
Google Season of Docs supports open-source projects to improve their documentation and allows professional technical writers to gain experience in open-source. Together we raise awareness of open source, docs, and technical writing.
Technical writing is an essential skill for professionals working in various industries. Whether writing software documentation, creating user guides, or developing training materials, communicating complex technical information clearly and effectively is crucial for success.
WRITING COMMUNITIES 👨👩👧👦
We consider everyone who cares about communication, documentation, and their users to be a community member. This can be programmers, tech writers, developer advocates, customer support, marketers, and anyone who wants people to have great experiences with software.
Our program is designed for individuals looking to improve their technical writing skills and advance their careers in software development, community management, and developer advocacy.