KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

Technical-Writing-Course-with-Curriculum

★ 154 Open GitHub ↗

https://hackmamba.io

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Course Curriculum - Beginner & Intermediate Level

This Curriculum by **[Hackmamba](https://hackmamba.io/)** 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](https://discord.com/invite/MjbyDy3sPp)** community and if you want to explore some exclusive opportunities with Hackmamba, fill out this [form](https://get.hackmamba.io/community-member)!

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.**

<details>
<summary>What is Technical Writing</summary>

**[Best Roadmap to Learn Technical Writing](https://dev.to/engroso/best-roadmap-to-learn-technical-writing-2057)**

**[How to Write Efficient Technical Blog Posts](https://www.youtube.com/watch?v=6LJ0-eHgBKc&t=74s)**

**[What is Technical Writing?](https://technicalwriterhq.com/writing/technical-writing/)**

**[Technical Writing: What and How?](https://edidiongasikpo.com/technical-writing-what-and-how)**

**[Everything you need to know to become a technical writer](https://www.everythingtechnicalwriting.com/everything-you-need-to-know-about-technical-writing/)**

**[The ABCs of Technical Writing](https://www.developernation.net/blog/the-abcs-of-technical-writing/)**

**[A software developer's guide to Writing](https://theankurtyagi.com/a-software-developers-guide-to-writing/)**

**[Types of Technical Writing](https://www.acadecraft.com/blog/types-of-technical-writing/)**
**[Getting started with technical writing - as a product](https://www.youtube.com/watch?v=CxjK52CSZ0o)**

</details>

<details>
<summary>Role of technical writers in an organization</summary>

**[Why is Technical Writing Important at Workplace](https://www.acadecraft.com/blog/reasons-why-is-technical-writing-important/)**

[**Why Technical Writing Is Critical to the Success of An Organisation**](https://keepler.io/2022/06/01/why-technical-writing-is-critical-to-the-success-of-an-organisation/)

</details>

<details>
<summary>Growth as a Technical Writer</summary>

**[What is the Technical Writer Career Path?](https://www.youtube.com/watch?v=RZF34wQEv0Y)**
**[Documentation metrics: Measuring the value of documentation (w/ Bob Watson)](https://hackmamba.io/blog/2024/08/documentation-metrics/)**

</details>

### 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.**

<details>
<summary>Essential Skills</summary>

**[Steps to creating an outstanding content outline for Technical Writers](https://hackmamba.io/blog/2024/08/content-outline-for-technical-writers/)**

**[A guide to creating a content brief for technical writers [+template]](https://hackmamba.io/blog/2024/07/content-brief-for-technical-writers-template/)**

**[9 Essential Technical Writing Skills Every Writer Must Possess](https://whatfix.com/blog/technical-writing-skills/)**

**[Essential Technical Writing Skills](https://technicalwriterhq.com/career/technical-writer/technical-writing-skills/)**

**[11 Skills of a Good Technical Writer](https://clickhelp.com/clickhelp-technical-writing-blog/11-skills-of-a-good-technical-writer/#interest-in-science-and-technology)**

**[How to generate ideas for technical content in 25 minutes](https://hackmamba.io/blog/2024/05/generate-ideas-for-technical-content/)**

**[How to Source Technical Blog Titles and Write Consistently - Colby, William](https://www.youtube.com/watch?v=axaCbfDnGm0)**

</details>

<details>
<summary>Topic Score</summary>
    
**[How is the topic score calculated?](https://kb.scompler.com/en/knowledge/how-is-the-topic-score-calculated)**
    
**[Technical Documentation in Software Development](https://www.altexsoft.com/blog/technical-documentation-in-software-development-types-best-practices-and-tools/)**
    
**[How can you evaluate the effectiveness of research in technical writing?](https://www.linkedin.com/advice/1/how-can-you-evaluate-effectiveness-research-technical-writing)**

</details>

<summary>Keyword Volume</summary>

**[Keyword Search Volume Insights: A Detailed Overview](https://neilpatel.com/blog/keyword-search-volume/)**

**[Keyword Search Volume: What It Is & How to Find It](https://www.semrush.com/blog/keyword-search-volume/)**

**[Keyword Research Tutorial: Best Strategies to Rank #1](https://youtu.be/NadiT0HYt4Y?si=aGIaY3XHlS5w-zd_)**

</details>

<summary>Search Trends</summary>
    
**[Blog Post Ideas](https://firstsiteguide.com/blog-post-ideas/)**
    
**[How to find topics](https://jackandbean.com/blog/how-to-find-topics/)**

</details>

## Resources and Tools for Best Practices 🗂️

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

### Tooling

<summary>Publishing Tools</summary>
 
**[Most Popular Tools for Technical Writing](https://document360.com/blog/tools-for-technical-writing/)**
    
**[Best Technical Writing Software and Tools for 2024](https://clickhelp.com/clickhelp-technical-writing-blog/15-best-technical-writing-software-and-tools/)**
    
**[Best Knowledge Base Software and Tools in 2024](https://clickhelp.com/clickhelp-technical-writing-blog/11-best-knowledge-base-software-and-tools/#what-is-a-knowledge-base-software)**
    
**[Essential Tools for Technical Writing](https://helpjuice.com/blog/technical-writing-tools)**
    
**[Authoring Tools for Technical Writers](https://www.linkedin.com/pulse/authoring-tools-technical-writers-comprehensive-overview-opere/)**

</details>

<summary>SEO Tools</summary>

[Best SEO Tools](https://zapier.com/blog/best-seo-tools/)

</details>

<summary>Plagiarism Checker</summary>

**[Best plagiarism checker 2024 revealed](https://youtu.be/y3k96r3Y1wQ?si=PAogvbCt315JtfX7)**

**[10 Best Free Plagiarism Checkers](https://www.scribbr.com/plagiarism/best-free-plagiarism-checker/)**

**[The 11 Best Plagiarism Checkers for Freelance Writers](https://www.jenniferberube.com/best-plagiarism-checkers-for-freelance-writers/)**

</details>

<summary>Editing Tools</summary>

**[Best Writing & Editing Tools in 2024](https://www.semrush.com/blog/content-editing-tools/)**

**[The Best Free & Paid Proofreading & Editing Software](https://scribemedia.com/proofreading-editing-software/)** by **Tucker Max**

**[Leading Low-Code Documentation Tools for Technical Writers](https://hackmamba.io/blog/2024/09/low-code-documentation-tools/)**

</details>

<summary>Git / Version Control</summary>

**[Getting Started - About Version Control](https://git-scm.com/book/en/v2/Getting-Started-About-Version-Control)**

**[Git for Professionals Tutorial - Tools & Concepts for Mastering Version Control with Git](https://youtu.be/Uszj_k0DGsg?si=Oz3pJquBy1DCjONc)**

</details>    
        
<details>

<summary>Markdown</summary>

**[The Only Markdown Crash Course You Will Ever Need](https://youtu.be/_PPWWRV6gbA?si=Euu86WZk21soZnq8)**

**[An overview of Markdown, how it works, and what you can do with it](https://www.markdownguide.org/)**

**[Mermaid](https://mermaid.js.org/intro/)**

**[Dillinger](https://dillinger.io/)**

**[Online Markdown Editor](https://onlinemarkdowneditor.dev/)**

**[Readme](https://readme.so/editor)**

</details>

<summary>Publishing Platforms</summary>
    
**[Medium](https://medium.com/)**
    
**[Hashnode](https://hashnode.com/)**
    
**[Dev.to](https://dev.to/)**
    
**[Daily Dev](https://daily.dev/)**
    
**[freeCodeCamp](https://www.freecodecamp.org/)**

**[Ghost](https://ghost.org/)**

**[Hacker News](https://news.ycombinator.com/)**

**[Hackernoon](https://hackernoon.com/)**

**[Top 5 Open-Source Documentation Development Platforms of 2024](https://hackmamba.io/blog/2024/02/top-5-open-source-documentation-development-platforms-of-2024/)**

</details>

### Networking

<summary>Communities & Forums</summary>

[**Technical Writing Communities**](https://medium.com/technical-writing-is-easy/technical-writing-communities-ef807c11134c)

[**Technical Writing Forums and Communities**](https://blog.contentre.io/technical-writing-forums-and-communities/)

**[Technical Typers community](https://discord.gg/2zGqkPVAy6)**

**[Reddit](https://www.reddit.com/r/technicalwriting/)**

**[Non Technical in Tech](https://join.slack.com/t/nontechintech/shared_invite/zt-s9eg89md-oa_0xTZpVn2iYZvOoAIhBQ)**

**[Linkedin Technical Writing Group](https://www.linkedin.com/groups/112571/)**

**[The Markup Scribe by William Imoh](https://subscribe.dentry.io/lr2F0z)**

**[Write the Docs Newsletter](https://www.writethedocs.org/newsletter/)**

**[I'd Rather Be Writing Newsletter](https://idratherbewriting.com/newsletter/)**

**[Everything Technical Writing](https://www.everythingtechnicalwriting.com/#subscribe-form)**

**[Technical Writing Insiders by Josh Fechter](https://technicalwriterhq.com/newsletter-subscribe/)**

**[Technical Writing for Developers](https://www.subscribepage.com/technicalwriting)**

**[Source Code by Suraj Vishwakarma](https://substack.com/@surajondev)**

**[Top 5 Technical Writing Communities of 2024](https://hackmamba.io/blog/2024/03/top-5-technical-writing-communities-of-2024/)**

</details>

### Best Practices

<summary>Best practices</summary>
    
**[Top 10 Tips for Great Technical Writing](https://document360.com/blog/top-10-tips-for-great-technical-writing/)**
    
**[Best Practices in Technical Writing](https://www.gcu.edu/blog/language-communication/best-practices-technical-writing)**
    
**[Technical Writing: 6 Best Practices for Effective Content](https://proedit.com/technical-writing-best-practices/)**

**[Top 7 Practical Tips for Creating Effective SaaS Documentation: A Comprehensive Guide]()https://hackmamba.io/blog/2023/06/top-7-practical-tips-for-creating-effective-saas-documentation-a-comprehensive-guide/**

**[Tips For Writing Great Technical Content](https://www.youtube.com/watch?v=wqdeJhzIYI8)**

**[Steps to creating an outstanding content outline for Technical Writers](https://hackmamba.io/blog/2024/08/content-outline-for-technical-writers/)**

</details>

### Learning Outcomes

<summary>Resources</summary>

**[Working with APIs by Knowledge Owl](https://www.notion.so/Resources-and-Best-Practices-0cd869f629d649369e0f9c6e084aa7e0?pvs=21)**

**[Learn Markdown](https://www.notion.so/Resources-and-Best-Practices-0cd869f629d649369e0f9c6e084aa7e0?pvs=21)**

**[Git and Version Control](https://www.notion.so/Resources-and-Best-Practices-0cd869f629d649369e0f9c6e084aa7e0?pvs=21)**

**[Top 5 online mentorship platforms for technical writers](https://hackmamba.io/blog/2024/07/mentorship-platforms-for-technical-writers/)**

</details>

### Podcasts

<summary>Resources</summary>

**[Everything Outside Code](https://www.youtube.com/@hackmamba)**

**[Thenotboringtechwriter Podcast](https://www.thenotboringtechwriter.com/)**

**[Technical Marketing Handbook](https://www.stitcher.com/show/technical-marketing-handbook)**

**[10 Mins Tech Comm](https://www.stitcher.com/show/10minute-tech-comm)**

**[API THE DOCS podcast](https://apithedocs.org/podcast?page=1)**

</details>

### Books

<summary>Good Reads</summary>

**[Open Technical Communication!](https://alg.manifoldapp.org/read/open-technical-communication/section/67ef90ba-8ca3-4e8e-abb0-0a3966cf2ac7)**

**[Docs for Developers](https://www.amazon.com/dp/1484272161/ref=cm_sw_r_awdo_navT_g_SV4HMY0QJNCGSEZ96T21)**

**[The Mayfield Handbook of Technical and Scientific Writing](http://www.mit.edu/course/21/21.guide/toc.htm)**

**[Writing Handbook](https://www.julian.com/guide/write/intro)**

**[Technical Writing 101: A Real-World Guide to Planning and Writing Technical Content](https://www.gettextbooks.com/isbn/9780970473363/)**

**[Docs for Developers](https://learning.oreilly.com/library/view/docs-for-developers/9781484272176/html/505277_1_En_BookFrontmatter_OnlinePDF.xhtml)**

</details>

### Courses

<summary>Resources</summary>

**[Learn Tech Writing](https://learntechwriting.co/index.html)**

**[Tech Writers Master Class](https://www.udemy.com/course/tech-writers-master-class/)**

**[Technical writing course by TechnicalWriterHQ](https://technicalwriter.teachable.com/p/home?referral_code=6TJ7SI?ref=everythingtechnicalwriting.com) (paid)**

**[Fundamentals of Technical Writing by Ed2go](https://www.ed2go.com/courses/writing/writing-and-editing/ilc/fundamentals-of-technical-writing?ref=everythingtechnicalwriting.com) (paid)**

**[Technical writing course by Google](https://developers.google.com/tech-writing?ref=everythingtechnicalwriting.com) (free)**

**[Writing for Software developers](https://philipkiely.gumroad.com/l/uZPZU?ref=everythingtechnicalwriting.com) (paid)**

**[Open technical communication course](https://alg.manifoldapp.org/projects/open-tc?ref=everythingtechnicalwriting.com) (free)**

**[Technical writing: Documentation on software projects by Pluralsight](https://app.pluralsight.com/library/courses/technical-writing-software-documentation/table-of-contents?ref=everythingtechnicalwriting.com) (paid)**

**[All of HubSpot's SEO courses, in one place](https://www.hubspot.com/resources/courses/seo)**

**[10 Completely Free SEO Training Courses](https://ahrefs.com/blog/free-seo-courses/)**

**[Complete SEO Course for Beginners](https://youtu.be/xsVTqzratPs)**

</details>

## Guides and Types 🗺️

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

<summary>Forms of technical writing</summary>
    
**[Exploring the 11 Types of Technical Writing](https://www.acadecraft.com/blog/types-of-technical-writing/)**    
    
**[API Documentation Guide and Best Practices](https://stoplight.io/api-documentation-guide)**
    
**[Content Troubleshooting Guide](https://contentmanagementcourse.com/content-troubleshooting/content-troubleshooting-guide/)**

</details>

<details>
<summary>Style Guides</summary>

**[The freeCodeCamp Publication Style Guide](https://www.freecodecamp.org/news/developer-news-style-guide)**

**[Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/)**

**[Google Developer Documentation Style Guide](https://developers.google.com/style)**

**[Diátaxis](https://diataxis.fr/)**

**[Gitlab Documentation Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide/)**

**[Gatsby Style Guide](https://www.gatsbyjs.com/contributing/gatsby-style-guide/)**

**[Alistapart Style Guide](https://alistapart.com/about/style-guide/)**

</details>

## Research and SEO for Technical Writing 🔬

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

**[SEO Explained: What Is SEO?](https://www.youtube.com/watch?v=pIbQfOcsEsE)**

**[Keyword Research for SEO Beginners](https://www.youtube.com/watch?v=OMJQPqG2Uas)**

**[What is on-page SEO?](https://yoast.com/what-is-onpage-seo/)**

**[41 Best SEO Tools (Free & Paid](https://backlinko.com/best-free-seo-tools))**

**[Tips on Conducting Proper Research in Tech Writing](https://medium.com/technical-writing-is-easy/tips-on-conducting-proper-research-in-tech-writing-7eeba58bde81)**

**[Top 6 HTML Tags for SEO Every Developer Should Know](https://hackmamba.io/blog/2022/09/top-6-html-tags-for-seo-every-developer-should-know/)**

</details>

## Collaboration and Content Review 🤝

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

<summary>Collaborative Writing</summary>

**[Collaborative writing on Technical teams](https://www.youtube.com/watch?v=rde2nVaU-9s)**

**[The top 7 collaborative document editing tools](https://www.bynder.com/en/blog/the-top-7-collaborative-document-editing-tools/)**

**[7 Ways to Accelerate Your Content Review and Approval](https://contentmarketinginstitute.com/articles/accelerate-content-approval/)**

</details>

## Portfolio Development and Continuous Learning 💼

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

<summary>Writing Portfolio</summary>

**[How to create a Technical Writing Portfolio](https://www.everythingtechnicalwriting.com/technical-writing-portfolio/)**

**[Top Technical Writing Portfolio Examples 2024](https://technicalwriterhq.com/career/technical-writer/technical-writer-portfolio/)**

**[How to Build an Awesome Technical Writing Portfolio and 5 Excellent Examples](https://www.journoportfolio.com/blog/how-to-build-a-technical-writing-portfolio-and-5-excellent-examples/)**

**[Continuous Learning in Tech: Strategies for Keeping Your Skills Sharp Throughout Your Career](https://ivyexec.com/career-advice/2024/continuous-learning-in-tech-strategies-for-keeping-your-skills-sharp-throughout-your-career)**

**[What is continuous learning?](https://www.techtarget.com/whatis/definition/continuous-learning)**

</details>

<details>
<summary>Contributing to Open Source Projects</summary>

**[How to Contribute to Open Source – a Guide for Technical Writers](https://www.freecodecamp.org/news/how-to-contribute-to-open-source-for-technical-writers/)** By Valentine Gatwiri

**[Contributing to Hacktoberfest as a technical writer](https://www.everythingtechnicalwriting.com/contributing-to-hacktoberfest-as-a-technical-writer/)** By Linda Ikechukwu

**[Getting started with Open Source as a Technical Writer.](https://amara.hashnode.dev/getting-started-with-open-source-as-a-technical-writer)** By Amarachi Iheanacho

**[How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)**

**[4 tips to becoming a technical writer with open source contributions](https://opensource.com/article/21/11/technical-writing-open-source)** By Ashley Hardin

**[Contributing to open source docs as a technical writer](https://passo.uno/contribute-open-source-docs/)** By Fabrizio Ferri Benedetti

**[Open Source for Technical Writers - A Guide on how to make Contributions.](https://medium.com/@techwritershub/open-source-for-technical-writers-a-guide-on-how-to-make-contributions-ab1bb1962fc1)** By TechWriters Hub

**[The Technical Writers Guide to Contributing to Open Source Projects](https://edidiongasikpo.com/the-technical-writers-guide-to-contributing-to-open-source-projects)** By Edidiong Asikpo (Didi)

</details>

## Developer Marketing ➰

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

<details>
<summary>Market your content</summary>
<br>

**[What You Should Know About Developer Marketing](https://hackmamba.io/blog/2025/03/what-you-should-know-about-developer-marketing/)**

**[Can a developer marketing agency help you win the dev community?](https://hackmamba.io/blog/2024/05/can-developer-marketing-agency-win-dev-community/)**

**[You don’t need developer marketing unless…](https://medium.com/@blizzard2002/you-dont-need-developer-marketing-unless-0992514c0ff7)**

**[Top Developer Marketing Agencies](https://dev.to/engroso/top-developer-marketing-agencies-1kcg)**

**[If Your Developer Marketing Isn’t Working, Read This](https://hackmamba.io/blog/2025/03/developer-marketing-deep-dive/)**

**[Developer marketing doesn't exist... without DevX](https://hackmamba.io/blog/2024/11/developer-marketing-without-developer-experience/)**

</details>

## Job Opportunities 👨‍💼

**Explore some opportunities around Technical Writing.**

<details>
<summary>Check them out</summary>
<br>

**[Paying Opportunities](https://whopayswriters.me/)**

</details>

## Video Content Creation 📹

**Explore how to make good Video tutorials**

<details>
<summary>Check them out</summary>
<br>

**[How to make Video Tutorial on YouTube](https://youtu.be/llRF1ZuLaFE?si=Yv37InTVpNHfFvsQ)**

</details>

## 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 🔗

<details>
    
<summary>Channels</summary>

**[Youtube](https://www.youtube.com/@hackmamba)**

**[Website](https://hackmamba.io/)**

**[Linkedin](https://www.linkedin.com/company/hackmamba-io/)**

**[X](https://x.com/hackmamba)**

**[Blogs](https://hackmamba.io/blog/)**

</details>

## 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 | <img src="https://raw.githubusercontent.com/hackmamba-io/Technical-Writing-Course-with-Curriculum/main/.vaunt/hackmamba_star.png" width="150" /> | Awarded for starring our repository, make a wish! |
| Pull Request Hero | <img src="https://raw.githubusercontent.com/hackmamba-io/Technical-Writing-Course-with-Curriculum/main/.vaunt/hackmamba_contribute.png" width="150" /> | Thank you for contributing to our technical writing repository! |

Technical-Writing-Course-with-Curriculum

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README