Skip to content

BolajiAyodeji/awesome-technical-writing

master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 

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 list and awesome-jamstack list

Table of Contents

Community

Courses

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.

Useful Tools

  • technical-writing-template - A sample template for writing a technical article.
  • 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.
  • 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 - Goes beyond checking spelling and grammar, intelligent suggestions is also included 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.

Conferences

Speaker Decks

Books

Style Guides

Technical Writers to follow

Name Link to Blog Blog Niche Link to Twitter
Bolaji Ayodeji https://blog.bolajiayodeji.com Web Development, JAMstack, A11y @iambolajiayo
Angie Jones https://angiejones.tech Test Automation, Java @techgirl1908
Sarah Drasner https://sarah.dev/writing Web Development, Vuejs, SVGs @sarah_edo
Prosper Otemuyiwa https://medium.com/@unicodeveloper All things Technical & Magical @unicodeveloper
Ire Aderinokun https://bitsofco.de Frontend Development, 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, JamStack @seancdavis29
Alvaro Montoro https://dev.to/alvaromontoro css, html @alvaro_montoro
Linda Ikechukwu https://www.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 technical writer, resource, article, blog, tool, video, speaker deck etc.? Please send me a pull request and follow the contributors guidelines.

Contributors


Bolaji Ayodeji

🖋 📖 🎨

prachford

📖

Jude J Obiejesi

📖

Patrick Rachford

📖

Didicodes

📖

browncrussell

📖

Gareth Dwyer

📖

Peter Thaleikis

📖

Genesis Gabiola

📖

Thomas Vaillant

📖

Rostyslav Sipakov

📖

Linda Ikechukwu

📖

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.

About

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

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published