GithubHelp home page GithubHelp logo

masiedu4 / awesome-technical-writing Goto Github PK

View Code? Open in Web Editor NEW

This project forked from bolajiayodeji/awesome-technical-writing

0.0 0.0 0.0 148 KB

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

awesome-technical-writing's Introduction

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

📖
Marc Achtelig
Marc Achtelig

📖

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.

awesome-technical-writing's People

Contributors

bolajiayodeji avatar allcontributors[bot] avatar rachfop avatar linda-ikechukwu avatar hqrshguptq avatar rsipakov avatar jaybeeclassical avatar bhupesh-v avatar birdboybolu avatar sixhobbits avatar marcachtelig avatar spekulatius avatar sojinsamuel avatar thomvaill avatar browncrussell avatar pinksyngonium avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.