• Stars
    star
    1,660
  • Rank 28,156 (Top 0.6 %)
  • Language
  • Created about 5 years ago
  • Updated 11 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

📚 A curated list of awesome resources: articles, books, videos, tools, podcasts about technical writing.

Awesome Technical Writing

Awesome All Contributors

Technical writing is writing or drafting technical communication used in technical and occupational fields, such as computer hardware and software, engineering, chemistry, aeronautics, robotics, finance, medical, consumer electronics, biotechnology, and forestry. ~ Wikipedia

List inspired by the awesome and awesome-jamstack lists

Table of Contents

Community

Courses

Books

Style Guides

Useful Tools

  • technical-writing-template - A sample template with guidelines for writing technical articles.
  • Paid Community Writer Programs - A list of companies that have paid developer community writer programs.
  • Who Pays Technical Writers? - A curated collection of active publishers, publications, and agencies that pay fair rates for high-quality technical content.
  • HackMD - Real-time collaborate on technical documentation in markdown.
  • Dropbox Paper - A flexible workspace for collaborative document-editing.
  • Google Docs - Smart editing and styling tools to help you easily format text and paragraphs.
  • Notion - The all-in-one workspace for your notes, tasks, wikis and databases.
  • Notion AI - Leverage the limitless power of AI in any Notion page, write faster and augment your creativity.
  • Grammarly - a writing assistant that goes deeper than grammar to offer you comprehensive writing feedback.
  • Canva - A graphic design platform that allows you to create social media graphics, and other visual content.
  • TinyPNG - Smart PNG and JPEG image compression.
  • Full Page Screen Capture - The simplest way to take a full page screenshot of your current browser window.
  • Awesome Screenshot: Screen Video Recorder - Screen Capture full page screenshot and recorder for screencast.
  • Readme Markdown Generator - CLI that generates beautiful README.md files.
  • Capture to a Gif - Record content of pages to an animated gif picture from browser.
  • Microsoft Word - Spelling, grammar, and intelligent suggestions to assist you across documents, email, and on the web.
  • Log4brains - Docs-as-code knowledge base to manage Architecture Decision Records (ADR) for your project and publish them automatically as a static website.
  • Antidote - The corrector analyzes your text and flags any detections.
  • LanguageTool - Open-source writing assistant, an alternative to Grammarly.
  • HemingwayApp - Hemingway App makes your writing bold and clear. Helps fix long & complex sentences.
  • ChatGPT - A conversational chatbot that can generate human-like responses to natural language prompts.

Resources

Videos

Podcasts

  • The Manuscript Podcast - The intersection of writing and the development of technology products.
  • The Manuscript Academy Podcast - Interviews with agents and editors, how-to tips, and behind-the-scenes looks at the creation of the Academy.
  • Write the Docs Podcast - The Write the Docs Podcast publishes discussion-style podcasts focusing on topics related to the Write the Docs community.
  • The Not-Boring Tech Writer - The Not-Boring Tech Writer podcast introduces technical writers skills used in the open data movement.

Conferences

Speaker Decks

Some Technical Writers to follow

Name Link to Blog Blog Niche Link to Twitter
Bolaji Ayodeji https://blog.bolajiayodeji.com Web/Data Engineering, JavaScript, Python, Machine Learning, and Ecommerce. @iambolajiayo
Angie Jones https://angiejones.tech Test Automation, and Java. @techgirl1908
Sarah Drasner https://sarah.dev/writing Web Development, Vuejs, and SVGs. @sarah_edo
Prosper Otemuyiwa https://medium.com/@unicodeveloper All things Technical and Magical. @unicodeveloper
Ire Aderinokun https://bitsofco.de Frontend Development and JavaScript. @ireaderinokun
Tom Johnson https://idratherbewriting.com Technical Writing and API lessons. @tomjohnson
Anne Gentle https://justwriteclick.com Doc as Code. @annegentle
Kayce Basques https://kayce.basqu.es/blog Dev tools and Documentation. @kaycebasques
Tania Rascia https://taniarascia.com Modern JavaScript, Node.js, and development. @taniarascia
SWYX https://swyx.io/writing Web Development, React and Tech. @swyx
Sean C Davis https://cobwwweb.com/ Web Development and Jamstack. @seancdavis29
Alvaro Montoro https://dev.to/alvaromontoro CSS and HTML. @alvaro_montoro
Linda Ikechukwu https://everythingtechnicalwriting.com Technical Writing and Developer Documentation. @_mslinda
Amruta Ranade https://www.youtube.com/c/AmrutaRanade Technical Writing and Developer Documentation. @AmrutaRanade

Contributing

Found an awesome resource, article, book, tool, video, technical writer, speaker deck etc.? Please send in a pull request and follow the contributors guidelines. Thank you!

Contributors

Bolaji Ayodeji
Bolaji Ayodeji

🖋 📖 🎨
prachford
prachford

📖
Jude J Obiejesi
Jude J Obiejesi

📖
Patrick Rachford
Patrick Rachford

📖
Didicodes
Didicodes

📖
browncrussell
browncrussell

📖
Gareth Dwyer
Gareth Dwyer

📖
Peter Thaleikis
Peter Thaleikis

📖
Genesis Gabiola
Genesis Gabiola

📖
Thomas Vaillant
Thomas Vaillant

📖
Rostyslav Sipakov
Rostyslav Sipakov

📖
Linda Ikechukwu
Linda Ikechukwu

📖
Sojin
Sojin

📖
Ezefizzy
Ezefizzy

👀
Colin Sheppard
Colin Sheppard

🐛
Bhupesh Varshney
Bhupesh Varshney

📖
DMoosh
DMoosh

📖
Boluwatife Victor
Boluwatife Victor

📖
neevcollege
neevcollege

📖

Check out my blog, newsletter, or say hi on Twitter.

License

Creative Commons License
This work is licensed under a Creative Commons Attribution 4.0 International License.

More Repositories

1

technical-writing-template

🦄 A sample template with guidelines for writing technical articles.
490
star
2

awesome-jamstack

📔 Curated list of resources: books, videos, articles, speaker decks, tools about using the Jamstack.
146
star
3

js-code-snippets

Learn basic JavaScript concepts in action. ⚡
JavaScript
81
star
4

netty-finder

☎️ This script checks a Nigerian telephone number and detects which network it belongs to.
JavaScript
50
star
5

inspireNuggets

🌻 inspireNuggets is a Chrome Browser (Web) Extension that displays random inspiring techie quotes for developers/designers.
CSS
39
star
6

altschool-profile-template

The official README profile template for AltSchool Africa students.
38
star
7

OOP-JavaScript

Learn OOP JavaScript ⚡
JavaScript
36
star
8

image-search-app

A simple image search app
JavaScript
17
star
9

simple-ajax-library

A simple AJAX Library for making HTTP Requests
JavaScript
17
star
10

chat-with-siri

🤖 A text-to-speech chatbot built using Nextjs, OpenAI, and ElevenLabs.
TypeScript
17
star
11

inspireNuggetsSlackBot

A simple Slackbot that displays random inspiring techie quotes and jokes for developers/designers.
JavaScript
16
star
12

bolajiayodeji.com

💙 My personal website (WIP).
TypeScript
16
star
13

BolajiAyodeji

My automated GitHub README Profile built using Nodejs, TypeScript, and GitHub Actions.
TypeScript
15
star
14

simple-fetch-library

A simple Fetch API library for making HTTP Requests
JavaScript
14
star
15

deploy-ml-web-workshop

In this workshop, you will learn how to build a machine learning model using Python/Scikit-Learn, turn the model into an API using Python/Flask, test the API, build web applications using HTML/CSS/JavaScript/Nextjs, and deploy it to the web for global usage by end-users.
Jupyter Notebook
14
star
16

hugo101

Getting started with Hugo and Deploy to Netlify ⚡
HTML
11
star
17

bolajiayodeji.github.io

🦄
11
star
18

dotfiles

My dotfiles, aliases, configurations, and general workspace setup.
Shell
10
star
19

nextjs-blog

Simple Nextjs Blog
JavaScript
10
star
20

weight-converter

Simple weight converter 💪
HTML
10
star
21

speech-to-text

Simple speech to text app built with React and IBM Watson.
JavaScript
9
star
22

cl-jamstack-ecommerce-workshop

Build headless commerce web experiences with Jamstack and Commerce Layer.
8
star
23

cl-composable-commerce-workshop

In this workshop, you will learn how to build a completely static ecommerce solution with Commerce Layer, Demo Stores, and some other dev tools.
8
star
24

async-js

Learn Asynchronous JavaScript ⚡
JavaScript
8
star
25

conf-swag-demo-store

An ecommerce website built using the Commerce Layer Demo Store project.
JavaScript
7
star
26

face-detector

A PERN stack face detector app
JavaScript
7
star
27

learning-node

Learning NodeJS + ExpressJS 🦄
JavaScript
6
star
28

sensy-words-filter

Package for filtering out a list of sensitive words
JavaScript
6
star
29

vue-boilerplate

PWA vue development boilerplate setup with CLI3
Vue
5
star
30

movie_reviews_sentiment_analysis

A ML model that will predict whether a movie review is positive or negative.
Jupyter Notebook
5
star
31

sanity-commercelayer-demo

Commerce Layer Starter Demo
TypeScript
5
star
32

naira-converter

A simple PWA currency to Naira converter :octocat:
JavaScript
4
star
33

OOP-Book-Store

A simple book store built with JavaScript ⚡
JavaScript
4
star
34

react-google-map

Display Google Maps in React App with Google Maps API
JavaScript
4
star
35

nodejs-web-scraper

Web Scraping with Nodejs
JavaScript
4
star
36

rentify-frontend

Rentify is a virtual renting platform that allows you to rent your electronics and book rentals.
HTML
4
star
37

qrcode-builder

PWA QR Code Generator
HTML
4
star
38

github-users-finder

A simple GitHub users finder app
JavaScript
4
star
39

fed-unis-perf-eval

Research: Accessibility And Performance Evaluation Of Federal University Websites In Nigeria.
HTML
3
star
40

robo-friends

My first React App ⚛️ (A simple robots directory)
JavaScript
3
star
41

code-lab-demo

Template project for my PWA code-lab
HTML
3
star
42

weather-app

A simple weather app built with JavaScript
JavaScript
3
star
43

dom-tutorial-notes

Useful JavaScript DOM concepts :octocat:
HTML
3
star
44

day-of-birth-finder

This script checks your Date of Birth and detects the Day of the Week you were born.
HTML
3
star
45

attraktives-headshot

An image background removal app and a demo design editor built using CreativeEditor Engine/SDK and Clerk.
TypeScript
3
star
46

hh-store

Demo of a fully functional e-commerce store and blog for my "Integrating Hashnode Headless CMS with Ecommerce Platforms" tutorial.
TypeScript
2
star
47

twitter-bot

My personal twitter bot 🐦
JavaScript
2
star
48

face-detector-api

API for the face detector app
JavaScript
2
star
49

react-todo

WIP: A simple todo list app
JavaScript
2
star
50

bootstrap-starter-template

Basic Bootstrap Starter Template
HTML
2
star
51

hugo-boilerplate

A Hugo boilerplate for creating truly epic websites
JavaScript
2
star
52

Tech-Geeks-Hub

Community for Tech Geeks!
Hack
2
star
53

reusable-ui-demo

TypeScript
2
star
54

Thumbnail-Gallery-Template

Simple Bootstrap Thumbnail Gallery template | Grids
HTML
2
star
55

credit_card_fraud_detection

A basic machine learning model that will detect potential fraud cases from transactions so that customers won’t be charged for the items they did not purchase.
Jupyter Notebook
2
star
56

contentful-boilerplate

Boilerplate project for getting started using JavaScript with Contentful CMS
JavaScript
2
star
57

learnRegExp

Learning error handling in JavaScript with Regular Expressions
JavaScript
2
star
58

cl-twilio-webhooks-demo

A minimal demo for sending an SMS notification to customers when an SKU that had finished is back in stock using Commerce Layer Webhooks and Twilio SMS.
JavaScript
2
star
59

standard-inputs

My first ruby script
Ruby
2
star
60

iris_visualization

Some data visualization techniques practice on the Iris dataset with R.
HTML
2
star
61

OLD-portfolio-website

My personal portfolio website
HTML
1
star
62

elevenlabs-api-sandbox

Quick test of ElevenLabs API and client libraries.
Python
1
star
63

one-click-hugo-cms

CSS
1
star
64

jekyll-blog

Simple Jekyll Blog
HTML
1
star
65

Resume-Project

Resume
HTML
1
star
66

devSquareNewsletter

Devcenter Square SendGrid Newsletter Form
CSS
1
star
67

Login-Signup-Page1

Simple User page for Signup, Login & forgot password.
CSS
1
star
68

mortgage-calculator

simple mortgage-calculator
HTML
1
star
69

Basic-Prototype

#iHackAfrica2018 Hackathon
CSS
1
star
70

Hello-world

My first respository on github
HTML
1
star
71

cl-sendgrid-webhooks

Sample code and templates for sending emails to customers using Commerce Layer Webhooks, Zapier Code Runner, Nodejs, and SendGrid API.
HTML
1
star
72

emperorphotoshop

Homepage for Emperor Photo Shop
JavaScript
1
star
73

open-sauced-goals

1
star
74

Extinct-Portfolio

My personal portfolio website
JavaScript
1
star
75

scrimba-react

JavaScript
1
star
76

Mock-Design-Project

Mock Design
JavaScript
1
star
77

Techne-Republic

Website for TechneRepublic
CSS
1
star
78

iOS-Calculator

PWA Calculator with iOS user interface for Web, Android & iOS.
JavaScript
1
star
79

JS-Guessing-Game

Simple guessing game built with Javascript
JavaScript
1
star
80

linear-regression

Linear regression attempts to model the relationship between two variables by fitting a linear equation to observed data.
R
1
star
81

Animated-Menu-Icon

Simple Menu Icon Animation
HTML
1
star
82

diabetes-prediction

HTML
1
star
83

TodoList-App-Mavo

To-Do List App Built with MAVO, HTML5 and CSS3
CSS
1
star
84

inspire-nuggets-web

Simple Quote Generator for Techies
JavaScript
1
star
85

pay-with-tweet

Commerce Layer Pay With Tweet external payment gateway.
TypeScript
1
star
86

dashmon-react-test

Code Test for Front-end Developer Role @ Dashmon
HTML
1
star
87

loan-calc

Simple loan calculator :octocat:
JavaScript
1
star
88

discord-bot

In progress...
TypeScript
1
star
89

Multiple-Slideshow

# Multiple Slideshow HTML5 | CSS3 | JS
JavaScript
1
star
90

BuyCoins-coding-challenge

Coding Challenge
HTML
1
star
91

task-manager

Simple Task Manager :octocat:
JavaScript
1
star
92

bar-bouncer

This app checks if a customer is eligible to enter a bar and buy an alcohol.
HTML
1
star
93

start-jekyll

Simple Jekyll Static Blog
Ruby
1
star
94

vue-socks-shop

A simple Vue socks e-Shop ⚡
JavaScript
1
star
95

JavaScript30-Projects

A Directory of all Projects built during WesBos #JavaScript30 Course
HTML
1
star
96

randomUsers

Implementation of How to Use the JavaScript Fetch API to Get Data
JavaScript
1
star
97

brain-gym

Simple number guessing game :octocat:
JavaScript
1
star
98

es6-modules-babel

JavaScript
1
star
99

contacts-filter

Simple list filter :octocat:
JavaScript
1
star
100

bookmarker

Bookmark your favorites sites :octocat:
JavaScript
1
star