tech-writing-tools icon indicating copy to clipboard operation
tech-writing-tools copied to clipboard

Suggested tools for technical writers

Tools for Technical Writers

GitHub repo size GitHub last commit GitHub stars Twitter Follow

This repository contains lists of suggested tools for technical writers. You can find it at https://alexand.us/tw-tools.

You are welcome to make a pull request and add tools that you've found helpful!

What's included

  • Multimedia - list of tools for creating images, GIFs, and videos
    • Planning your content - templates for planning your video content
    • Video production process - common steps in production and best practices
  • Text editors - recommended text editors for Markdown and other writing
  • Portfolios - recommended tools to create your portfolio

Other resources

  • Learning - articles and books to learn more about technical writing
  • Style - examples of content strategy and style guides
    • Fewer words - rules for writing with fewer words
  • Accessibility - resources for considering accessible writing and design
    • Style guide - specific style guide for a11y needs
  • Templates - example buckets of information to fill in for each type of document

About the author

Alexandra White is a technical writer for Google. Previously, she worked as a documentation editor for Joyent, web developer for WNET, and digital marketer for JCC Association. She has a degree in professional writing from Michigan State University.

You can find more of her work on heyawhite.com or follow her on Twitter @heyawhite.

Special thanks to @scottydocs, who heavily influenced the README template, and @nayafia and @embeddedartistry, who influenced the CONTRIBUTION template.

License

This project uses the Creative Commons Attribution Share Alike 4.0 International license.