• Stars
    star
    570
  • Rank 78,245 (Top 2 %)
  • Language
  • License
    MIT License
  • Created almost 8 years ago
  • Updated 10 months ago

Reviews

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

Repository Details

A collection of materials relating to technical writing

Technical Writing

For some reason, there are only a relatively small number of people who are interested in both technology and language. If you are one of them, technical writing can be a great profession, or means of generating a side income.

This repository is a collection of technical writing resources. Pull requests to add more resources are highly encouraged.

Writing Resources (Become a better writer)

Technical Writing Resources is a list of books and other resources to help you become a better technical writer

Publishing Resources (Get paid to write)

Publishing Resources provides information on where you can publish your technical posts, and who will pay you for them.

Technical writing communities

Communities is a list of communities focused on technical writing.

Software and Tools

Software and Tools is a list of writing tools and other automated programs built to support writers.

About

I used to write technical articles as a freelancer. I'm always surprised that while there are thousands of posts and resources out there relating to helping you become a better (programmer|founder|data scientist|anything else) there is very little about technical writing, and many people don't even know that technical writing is a thing that exists and that pays.

This is my little attempt to fill that gap. If you have suggestions for more sections, or want to add to existing sections, please submit a pull request. If you're not comfortable with git, Tweet at me with your suggestions or use one of the other contact options at the bottom of my website.

Since creating this, I founded Ritza - a startup that produces tutorials and documentation for companies and helps them with developer advocacy efforts. Get in touch if you're interested in our services, or if you'd be interested in writing for us.

More Repositories

1

python-telegram-tutorial

This is the code for a series of Tutorials that I wrote for Code Mentor.
Python
190
star
2

flask-crud-app

The code for my tutorial on CodeMentor about building a Flask CRUD web app
Python
29
star
3

yelp-dataset-2017

Submission to the Yelp Dataset Challenge 2017
Jupyter Notebook
15
star
4

nps-sample-data

Code to generate sample NPS (net promoter score) data as well as a sample dataset
Python
8
star
5

reader

A Flask App that makes news articles readable again by extracting the text and reformatting it.
HTML
8
star
6

udacity-image-class-project

Submission for the Udacity "Use a Pre-trained Image Classifier to Identify Dog Breeds" project
Python
7
star
7

unofficialeskom.com

Python
3
star
8

sklearn-intro

A practical introduction to Machine Learning using Python and scikit-learn. We build a clickbait classifier.
Jupyter Notebook
3
star
9

ngram

N-GrAM: New Groningen Author-profiling Model, Notebook for PAN at CLEF 2017
Python
2
star
10

crimemap

Example project for my book Flask By Example. An interactive map that users can use to report crimes and visualise historical crimes.
Python
2
star
11

eskom_scraper

Jupyter Notebook
2
star
12

waiter-caller

Example project for my book, Flask by Example. A web application that can be used by patrons to call a waiter to their table
Python
2
star
13

gymmemb

A basic membership application for door access-control at a gym (or anything else)
1
star
14

aws-snippets

Some reusable AWS-related code, mainly to stop me making the same mistakes over and over and over...
1
star
15

CorpusCreator

All in one corpus creator and manager
Python
1
star
16

novel-authorship-attribution

Jupyter Notebook
1
star
17

ritza

HTML
1
star
18

minimalist-markdown-website

A minimalist markdown website and pandoc builder
HTML
1
star
19

za-tender-expansions-deviations

Python
1
star
20

unisteg

Python
1
star