Technical Writing Weekly
#21
Dear writers community 👋!
Welcome to our technical writing newsletter!
We are excited to bring you the latest updates and resources in the world of technical writing, including job opportunities and career tips. Our newsletter is designed to keep you informed and inspired, whether you are a seasoned technical writer or just starting in the field.
From best practices in writing and editing to the latest trends in technology, we've got you covered. So please sit back, relax, and let us help you take your technical writing skills to the next level!
WRITING TIPS ✍🏿
Hello 👋🏾
My name is Wisdom Nwokocha. I'm a technical writer with over five years of experience. During this time, I've worked for several companies on projects of all sizes.
Over the years, I've had the opportunity to mentor a few people, but there's only so much one man can do. So, I decided to put my journey down on paper.
I've detailed every part of my journey to reach even more people. In this book, you'll learn firsthand from my experience about the basics of technical writing.
I wrote this book with the earnest intention that you will achieve your goals and dreams through writing, just as I have and continue to do. Below, you'll find a link to purchase this book.
You're not just buying some random technical writing book; you're buying my years of experience in a hard copy (or soft copy, if you prefer). I can't wait to see you create magic 🚀👑
You can purchase it here:
Stelar: https://selar.co/891yx2
Gumroad: https://lnkd.in/d6QbZGMG..
Technical Documentation Tips
AsciiDoc is a great choice for making and looking after top-notch documents because many companies and startups use it. Here are a few reasons why it's worth learning AsciiDoc in 2024:
1. Easy to understand
AsciiDoc's way of writing is easy and simple to learn, which makes it good for beginners. Unlike other ways of writing, BitmapDocs documents look much like plain text, so it's easy to understand and work on the content without getting stuck in many tags or formatting rules.
2. Flexible and useful
AsciiDoc can be used for all kinds of writing, from simple styling to complex documents. This means you can use the same tool for many kinds of writing, making things easier.
3. Works with lots of modern tools
AsciiDoc works well with many modern tools and websites, like GitHub and GitLab, and tools that make static sites, such as Antora.
4. Makes top-quality documents
With AsciiDoc, you can make good documents in different formats, like HTML, PDF, and ePub. This means you can make documents that fit different needs without losing quality.
5. Community and help
AsciiDoc has lots of people who use it and add to it. They have lots of helpful stuff, like training, forums, and extra tools. The community helps make AsciiDoc better and better.
Our Community’s Effort in Building a Comprehensive AsciiDoc Course
Remember to check out our upcoming AsciiDoc course! Our community is working hard to create a detailed and comprehensive course to help you become an expert in this powerful tool.
I've seen the team's dedication and expertise firsthand, and I'm confident this course will be practical and engaging. From basic syntax to advanced techniques, real-world examples, hands-on exercises, and best practices will be covered to ensure you understand AsciiDoc deeply.
This course will be incredibly valuable for anyone looking to enhance their documentation skills in 2024 and beyond. Stay tuned for updates, and join us in embracing the future of documentation with AsciiDoc!
Articles of the week
Introduction to Antora for beginners
By Wisdom Nwokocha
Antora is a static site generator that transforms AsciiDoc content into documentation sites.
AsciiDoc is a lightweight markup language for creating notes, articles, books, and web pages. Its simplicity allows complex documents using plain text files.
This guide walks you through building a documentation site with Antora and AsciiDoc, including exporting to PDF, HTML, and other formats.
How to Deploy a Dockerized Application to Amazon EKS Cluster
By Prince Onyeanuna
Containers are a way to package, deploy, and manage applications. Docker is a popular open-source containerization platform that allows you to package your application, its OS libraries, and dependencies together into a container image.
This container image can be run on any system regardless of the underlying OS.
JOBS 👩💻
Technical Writer - Startale
Fulltime, Remote
We are seeking a talented Technical Writer to join our Ecosystem Development team and play a crucial role in creating clear, concise, and engaging technical documentation for Astar & Startale’s products and developer tooling. As a Technical Writer, you will collaborate closely with our engineering, product, enterprise BD and developer support teams to produce high-quality documentation that enables developers & clients to understand and utilize our products effectively.
👉🏿 Apply Now
Senior Technical Writer at GitLab
Fulltime, Remote
As a Technical Writer at GitLab, you’ll collaborate with Engineers, who typically write the first draft of docs for the new features they create. You’ll dive in on special projects, planning and authoring new content, and helping craft new doc site features and processes. You’ll collaborate with others across the organization to help them contribute to the documentation. You’ll be at the leading edge of DevSecOps while contributing to one of the world’s largest open-source projects and engaging with our wider community.
👉🏿 Apply Now
Developer Experience Engineer at PylonA
Fulltime, Remote
This role is technical. You will need to be familiar with engineering and not be afraid to write code from time to time, but the bulk of the work will be in continuously improving our documentation to match the evolution of the product and our understanding of the learning process our customers go through as they integrate. Mortgage is complicated, so consistently maintaining a beginner's mind as you expand our documentation is critical to this role.
👉🏿 Apply Now
Writing contest ongoing
The #decentralize-ai Writing Contest by ICP & HackerNoon
Attention writers, developers, and AI enthusiasts! Join us for the inaugural ICP #decentralize-ai Writing Competition, a unique opportunity to showcase your insights and creativity regarding decentralized AI and the Internet Computer Protocol.
By entering, you can win from a $1,000 prize pool and contribute to the growing body of knowledge regarding decentralized AI on ICP.
The #bitcoin Writing Contest Rootstock & HackerNoon
The #bitcoin Writing Contest, presented by Rootstock and HackerNoon, is now live. The total prize pool is $17,500!
Whether you're a thought leader, a skilled writer, a talented developer, or passionate about blockchain technology, this contest invites you to showcase your expertise in various Bitcoin-related topics.
Throw your hat in the ring with the #bitcoin tag and stand a chance to win!
The Opt-Out Writing Contest
Āut Labs and HackerNoon are glad to announce "Opt out": a call to all "hacktivists" and thinkers who dare to question and challenge the status quo, the societal construct where we live. Using decentralized technology and collective autonomy to shake its very foundations - made of bureaucracy, institutions, and authoritarian legacy.
The Opt Out competition grants $9000 in USDT to the best writers. It expands over three (3) main themes for nine months, making it one of the longest writing contests in Web3's history.
The #blockchain-api Writing Contest by dRPC & HackerNoon
The #blockchain-api Writing Contest by dRPC and HackerNoon is an exciting opportunity for builders, innovators, and everyone involved in the blockchain industry to share their insights on blockchain APIs. Participants are also encouraged to showcase their experience with the dRPC platform. Request a free, premium gift card today!
Submissions can cover topics like blockchain API overviews, exploring popular APIs and RPC nodes, discussing Web3 dApp development, MEV protection, censorship resistance, the benefits of load balancing systems, and more.
Share your stories with the #blockchain-api tag and win a $1,000 prize pool slice.
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.