Skip to content

hackmamba-io/Technical-Writing-Course-with-Curriculum

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

85 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Course Curriculum - Beginner & Intermediate Level

This Curriculum by Hackmamba is designed for newbie and beginner technical writers who want to excel in technical writing and learn more about it.

If you have questions or want to network with other technical writers, join our Discord community and if you want to explore some exclusive opportunities with Hackmamba, fill out this form!

Make sure to give us a star ⭐ on this repository. This will help us out a lot to improve and work on amazing projects and programs like these!

Introduction to Technical Writing 📝

Introduction

Understand the definition, importance, and role of technical writing.

What is Technical Writing

Best Roadmap to Learn Technical Writing

How to Write Efficient Technical Blog Posts

What is Technical Writing?

Technical Writing: What and How?

Everything you need to know to become a technical writer

The ABCs of Technical Writing

A software developer's guide to Writing

Types of Technical Writing Getting started with technical writing - as a product

Role of technical writers in an organization

Why is Technical Writing Important at Workplace

Why Technical Writing Is Critical to the Success of An Organisation

Growth as a Technical Writer

What is the Technical Writer Career Path? Documentation metrics: Measuring the value of documentation (w/ Bob Watson)

Activities:

Write a short introduction about technical writing based on these resources and publish it on any blogging platform.

Required Skills for Technical Writers ⚙️

Understand Keywords, topic score, and researching skills required to stand out as a Technical Writer.

Essential Skills

Steps to creating an outstanding content outline for Technical Writers

A guide to creating a content brief for technical writers [+template]

9 Essential Technical Writing Skills Every Writer Must Possess

Essential Technical Writing Skills

11 Skills of a Good Technical Writer

How to generate ideas for technical content in 25 minutes

How to Source Technical Blog Titles and Write Consistently - Colby, William

Topic Score

How is the topic score calculated?

Technical Documentation in Software Development

How can you evaluate the effectiveness of research in technical writing?

Keyword Volume

Keyword Search Volume Insights: A Detailed Overview

Keyword Search Volume: What It Is & How to Find It

Keyword Research Tutorial: Best Strategies to Rank #1

Search Trends

Blog Post Ideas

How to find topics

Resources and Tools for Best Practices 🗂️

Discover essential resources, software, and methodologies to enhance productivity, maintain quality, and follow industry-standard best practices.

Tooling

Publishing Tools

Most Popular Tools for Technical Writing

Best Technical Writing Software and Tools for 2024

Best Knowledge Base Software and Tools in 2024

Essential Tools for Technical Writing

Authoring Tools for Technical Writers

SEO Tools

Best SEO Tools

Plagiarism Checker

Best plagiarism checker 2024 revealed

10 Best Free Plagiarism Checkers

The 11 Best Plagiarism Checkers for Freelance Writers

Editing Tools

Best Writing & Editing Tools in 2024

The Best Free & Paid Proofreading & Editing Software by Tucker Max

Leading Low-Code Documentation Tools for Technical Writers

Git / Version Control

Getting Started - About Version Control

Git for Professionals Tutorial - Tools & Concepts for Mastering Version Control with Git

Markdown

The Only Markdown Crash Course You Will Ever Need

An overview of Markdown, how it works, and what you can do with it

Mermaid

Dillinger

Online Markdown Editor

Readme

Publishing Platforms

Medium

Hashnode

Dev.to

Daily Dev

freeCodeCamp

Ghost

Hacker News

Hackernoon

Top 5 Open-Source Documentation Development Platforms of 2024

Networking

Communities & Forums

Technical Writing Communities

Technical Writing Forums and Communities

Technical Typers community

Reddit

Non Technical in Tech

Linkedin Technical Writing Group

The Markup Scribe by William Imoh

Write the Docs Newsletter

I'd Rather Be Writing Newsletter

Everything Technical Writing

Technical Writing Insiders by Josh Fechter

Technical Writing for Developers

Source Code by Suraj Vishwakarma

Top 5 Technical Writing Communities of 2024

Best Practices

Best practices

Top 10 Tips for Great Technical Writing

Best Practices in Technical Writing

Technical Writing: 6 Best Practices for Effective Content

Top 7 Practical Tips for Creating Effective SaaS Documentation: A Comprehensive Guidehttps://hackmamba.io/blog/2023/06/top-7-practical-tips-for-creating-effective-saas-documentation-a-comprehensive-guide/

Tips For Writing Great Technical Content

Steps to creating an outstanding content outline for Technical Writers

Learning Outcomes

Resources

Working with APIs by Knowledge Owl

Learn Markdown

Git and Version Control

Top 5 online mentorship platforms for technical writers

Podcasts

Resources

Everything Outside Code

Thenotboringtechwriter Podcast

Technical Marketing Handbook

10 Mins Tech Comm

API THE DOCS podcast

Books

Good Reads

Open Technical Communication!

Docs for Developers

The Mayfield Handbook of Technical and Scientific Writing

Writing Handbook

Technical Writing 101: A Real-World Guide to Planning and Writing Technical Content

Docs for Developers

Courses

Resources

Learn Tech Writing

Tech Writers Master Class

Technical writing course by TechnicalWriterHQ (paid)

Fundamentals of Technical Writing by Ed2go (paid)

Technical writing course by Google (free)

Writing for Software developers (paid)

Open technical communication course (free)

Technical writing: Documentation on software projects by Pluralsight (paid)

All of HubSpot's SEO courses, in one place

10 Completely Free SEO Training Courses

Complete SEO Course for Beginners

Guides and Types 🗺️

Explore various guides and types of technical documentation, their purposes, and how to choose the right format for your audience.

Forms of technical writing

Exploring the 11 Types of Technical Writing

API Documentation Guide and Best Practices

Content Troubleshooting Guide

Style Guides

The freeCodeCamp Publication Style Guide

Microsoft Writing Style Guide

Google Developer Documentation Style Guide

Diátaxis

Gitlab Documentation Style Guide

Gatsby Style Guide

Alistapart Style Guide

Research and SEO for Technical Writing 🔬

Learn effective research methods and SEO strategies to create high-ranking, audience-focused technical content.

What is SEO?

SEO Explained: What Is SEO?

Keyword Research for SEO Beginners

What is on-page SEO?

41 Best SEO Tools (Free & Paid)

Tips on Conducting Proper Research in Tech Writing

Top 6 HTML Tags for SEO Every Developer Should Know

Collaboration and Content Review 🤝

Understand the importance of teamwork and structured review processes to deliver accurate, polished, and impactful technical content.

Collaborative Writing

Collaborative writing on Technical teams

The top 7 collaborative document editing tools

7 Ways to Accelerate Your Content Review and Approval

Portfolio Development and Continuous Learning 💼

Master the art of showcasing your technical writing skills and stay updated with evolving trends through lifelong learning.

Writing Portfolio

How to create a Technical Writing Portfolio

Top Technical Writing Portfolio Examples 2024

How to Build an Awesome Technical Writing Portfolio and 5 Excellent Examples

Continuous Learning in Tech: Strategies for Keeping Your Skills Sharp Throughout Your Career

What is continuous learning?

Contributing to Open Source Projects

How to Contribute to Open Source – a Guide for Technical Writers By Valentine Gatwiri

Contributing to Hacktoberfest as a technical writer By Linda Ikechukwu

Getting started with Open Source as a Technical Writer. By Amarachi Iheanacho

How to Contribute to Open Source

4 tips to becoming a technical writer with open source contributions By Ashley Hardin

Contributing to open source docs as a technical writer By Fabrizio Ferri Benedetti

Open Source for Technical Writers - A Guide on how to make Contributions. By TechWriters Hub

The Technical Writers Guide to Contributing to Open Source Projects By Edidiong Asikpo (Didi)

Developer Marketing ➰

Explore strategies to effectively market technical products and services, bridging the gap between developers and their audience.

Market your content

What You Should Know About Developer Marketing

Can a developer marketing agency help you win the dev community?

You don’t need developer marketing unless…

Top Developer Marketing Agencies

If Your Developer Marketing Isn’t Working, Read This

Developer marketing doesn't exist... without DevX

Job Opportunities 👨‍💼

Explore some opportunities around Technical Writing.

Check them out

Paying Opportunities

Video Content Creation 📹

Explore how to make good Video tutorials

Check them out

How to make Video Tutorial on YouTube

Our Top Contributors ✨

Hackmamba wouldn't be Hackmamba without you. Every contribution counts. Thank you for being part of this journey.

Our Social Media Channels 🔗

Channels

Youtube

Website

Linkedin

X

Blogs

Available Badges

To earn these exclusive custom badges, star or contribute to our repository. These badges can also be used to showcase in your Portfolio!

Name Icon Description
Hackmamba Star Awarded for starring our repository, make a wish!
Pull Request Hero Thank you for contributing to our technical writing repository!

Releases

No releases published

Packages

No packages published

Contributors 8