Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cynthiapeter/technical-writing-resources

A collection of blogpost, resources, and links that has helped me in my journey as a technical writer. I still refer to them and contribute to the list as I find more.
https://github.com/cynthiapeter/technical-writing-resources

documentation technical technical-writing writing-articles

Last synced: about 1 month ago
JSON representation

A collection of blogpost, resources, and links that has helped me in my journey as a technical writer. I still refer to them and contribute to the list as I find more.

Awesome Lists containing this project

README 

        

![Technical Writing Resources](https://user-images.githubusercontent.com/33583060/179394775-49202628-3949-43e4-91ce-a9d215704aaa.png)



# Technical-Writing-Resources



**Hi there🙌🏾**



I hope you are doing well. 

This is a compilation of essential links I have encountered as a writer. I hope this helps you too.



## Getting Started



[Technical Writing Roadmap](https://roadmap.sh/technical-writer) By Hackmamba X iChuloo



**Blogs**



  - [A beginners guide to get started with technical writing](https://cynthiapeter.com/a-beginners-guide-to-get-started-with-technical-writing) By Cynthia Peter.

  - [Technical Writing - A beginners Guide](https://developers.deepgram.com/blog/2022/03/technical-writing-a-beginners-guide/) By Bekah Hawrot Weigel.

  - [What is Technical Writing ](https://uxwritinghub.com/what-is-technical-writing/) By UX Writing Hub.

  - [Everything You need to Know about Technical Writing](https://www.everythingtechnicalwriting.com/everything-you-need-to-know-about-technical-writing/) By Lynda.

  - [Technical Writing - The what and How](https://edidiongasikpo.com/technical-writing-what-and-how) By Edidiong Asikpo.

  - [What is Technical Writing?](https://www.instructionalsolutions.com/blog/what-is-technical-writing) by Kara Latz.

  - [What is Technical Writing](https://technicalwriterhq.com/writing/technical-writing/) By TechnicalWriterHq

  - [A software developer's guide to Writing](https://theankurtyagi.com/a-software-developers-guide-to-writing/) By Ankur Tyagi

  - [How to Create Technical Documentation with Examples](https://document360.com/blog/technical-documentation/) By Kingson S

  - [Software Documentation Best Pratices With Examples](https://helpjuice.com/blog/software-documentation/) By David Oragui



**Courses**

  -  [Learn Tech Writing](https://learntechwriting.co/index.html) by Arnab Ghosh.

  - [Tech Writers Master Class](https://www.udemy.com/course/tech-writers-master-class/) By Janet Underwood.

 



## Types of Documentation You may need to do as a Technical writer:



### API Documentation

  * [Working with APIs](https://support.knowledgeowl.com/help/working-with-apis) By KnowlegdeOwl.

  * [Postman Learning center](https://learning.postman.com/docs/publishing-your-api/documenting-your-api/) for API docs.

  * [Documenting APIs](https://idratherbewriting.com/learnapidoc/) A guide for technical writers and engineers.

  * [API Docs](https://apidocsfordevs.com/) for Devs By Shalvah.

  * [Getting Started in API Documentation](http://writeonce.org/starting_as_a_programmer_writer.php) By Robert Delwood.

  * [How to Read API Documentation](https://www.departmentofproduct.com/blog/how-to-read-api-documentation/) By Richard Holmes



### Learn about APIs

  * [Postman Academy](https://academy.postman.com/) By Postman. I highly recommend this resource. Taking all or any of the courses in this series will help you understand APIs and how to use Postman.

  * [An introduction to APIs](https://zapier.com/resources/guides/apis) by Zapier. This course breaks down APIs for beginners.



### Building Documentation site

* [How to create a documentation site from scratch](https://medium.com/empathyco/how-to-create-a-documentation-site-from-scratch-3ce54bf0257) By José A. Blanco

* [How to build a docs site](https://dev.to/michaelcurrin/how-to-build-a-docs-site-4h42) By  Michael Currin



### Doc-as-code

* [Docs as Code: A Development Approach to Documentation](https://www.makeuseof.com/docs-as-code-overview/) By Ukeje Chukwuemeriwo Goodness

* [What Is Docs as Code and Why Does It Matter?](https://nordicapis.com/what-is-docs-as-code-and-why-does-it-matter/) By Kristopher Sandoval

* [Documentation as Code: why you need it and how to get started](https://swimm.io/learn/code-documentation/documentation-as-code-why-you-need-it-and-how-to-get-started/) By Swimm Team 



### 4c Documentation Model

* [Documentation ystem](https://www.documentation.divio.com/introduction) by Divio

* [How the Docs are Structured](https://www.gatsbyjs.com/contributing/docs-contributions/docs-structure) By Gatsby



### Getting Started Guide



  📰 [Getting Started Guide retrospective: ](https://www.knowledgeowl.com/home/getting-started-guide-retrospective) The good, the bad, the ugly – By Kate Mueller

 

### Articles and Blogs



  🪄 [21 Tips to write better posts for devs](https://semaphoreci.com/blog/tips-to-write-for-developers).



### Guides and FAQs



  * [ReadTheDocs - Writing Documentation Guide](https://docs-guide.readthedocs.io/en/latest/writing/).



### Style Guides



When deciding how to create content, it is important to pay attention to some companies that already have amazing styleguides to guide you. A list of remarkable style guides you can get inspiration from are:



  * [Microsoft](https://docs.microsoft.com/en-us/style-guide/welcome/).

  * [Google](https://developers.google.com/style) provides editorial guidelines for writing clear and consistent Google-related developer documentation.

  * [Diátaxis](https://diataxis.fr/) - A systematic framework for technical documentation authoring.

  * [Gitlab Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide/).

  * [Alistapart Style Guide](https://alistapart.com/about/style-guide/).

  * [Gatsby StyleGuides](https://www.gatsbyjs.com/contributing/gatsby-style-guide/).

  * The [FreeCodeCamp](https://www.freecodecamp.org/news/developer-news-style-guide/) Publication Style Guide.

  

  

  **Extra:**

  

  * [How to write your style guide as a Technical Writer](https://wonexo.hashnode.dev/how-to-write-a-style-guide-as-a-technical-writer) By Segun Olumide.

  



### Defining Tone Of Voice



  * [Monzo](https://monzo.com/tone-of-voice/).



  * [Microsoft's brand voice: ](https://docs.microsoft.com/en-us/style-guide/brand-voice-above-all-simple-human) Above all, simple and human.



  * Atlassian Design System - [Voice and design Principles](https://atlassian.design/content/voice-and-tone-principles).



  * [Shopify Voice and Tone](https://polaris.shopify.com/content/voice-and-tone#navigation).



## Tools



  **Technical Writing Tools**

   * Learn [Adobe frame maker.](https://my.adobeconnect.com/introduction-to-framemaker/)

   * Learn [Adobe frame maker.](https://my.adobeconnect.com/introduction-to-framemaker/)



  **Productivity and Content Planning**



   * [How I use Notion for my Article and Content Ideas](https://www.youtube.com/watch?v=yxbAX6vTUgc) By Dillion Megida.

   * [Feedly](https://feedly.com/i/welcome) lets you get the news you want all in one place.



  **Grammar**

  

   * [Grammarly](https://app.grammarly.com/) helps you write mistake-free in Gmail, Facebook, Twitter, LinkedIn, and any other app you use.



  **Plagiarism Checker**



   * [Quetext's](https://www.quetext.com/) plagiarism checker analyzes your text to identify plagiarism, resolve other writing issues, and easily build citations.

  

  **Paraphrasing Tool**



   *  [Quillbot](https://quillbot.com/) Helps you rewrite and enhance any sentence, paragraph, or article using state-of-the-art AI.

  

   * [Wordtune](https://www.wordtune.com/) is an AI-powered writing companion that understands what you’re trying to say, and suggests ways to make your writing clearer, compelling and authentic. 

  

  **Graphics**

 

   * Create cover images for your articles and blog posts using [Canva](canva.com).

  

   * [Make drawings, highlights, blurs, on Screenshot](https://annotely.com/).

  

   * [Mermaid](https://mermaid-js.github.io/mermaid/#/README) lets you create diagrams and visualizations using text and code.

  

 **CrossPost**

 

  → [CrossXpost](https://crossxpost.app/)



  **AI Tools**

   * [Phind](https://www.phind.com/)

   * [Chat GPT](https://chat.openai.com/)

  

**Extras**   



  → [To check trends](https://trends.google.com/).

  

  → [Headline analyzer](https://headlines.coschedule.com/headlines)

  

  → [Americans with disability act](https://adata.org/learn-about-ada).

  

  → [Writing in plain language](https://www.plainlanguage.gov/law/).

  

  → [Inclusive writing for everyone](https://www.witty.works/).

  

  → [Passive voice detector](https://datayze.com/passive-voice-detector).

  



## Best Practices - Developer Experience(DX)



  ✨ [The 7 Sins of Developer Experience](https://betta.io/blog/2017/11/10/the-seven-sins-of-developer-experience/) By [Christiano Betta](https://betta.io/). This resource gives you an insight into Developer Experience.



  ✨ [Developer experience in terms of API design](https://apisyouwonthate.com/).

 

  

## Community and Newsletters



   * [Technical Typers community](https://discord.gg/2zGqkPVAy6).

   * [Reddit](https://www.reddit.com/r/technicalwriting/).

   * [Non Technical in Tech](https://join.slack.com/t/nontechintech/shared_invite/zt-s9eg89md-oa_0xTZpVn2iYZvOoAIhBQ).

   * [Linkedin Technical Writing Group](https://www.linkedin.com/groups/112571/).



**Newsletters📬✉️**



   * [The everything technical writing newsletter](https://www.getrevue.co/profile/_mslinda?subscribe_form=issue-page-header) By Linda Ikechukwu.



   * [Dentry Newsletter](http://subscribe.dentry.io/) By William Imoh: Receive entry-level and intermediate roles in software engineering, design, and product management.



**Podcasts🎙🎙**



   * [Thenotboringtechwriter Podcast](https://www.thenotboringtechwriter.com/) By Jacob Moses.



   * [Technical Marketing Handbook](https://www.stitcher.com/show/technical-marketing-handbook).



   * [10 Mins Tech Comm](https://www.stitcher.com/show/10minute-tech-comm).



   * [API THE DOCS podcast](https://apithedocs.org/podcast?page=1).



**Books📘📘**



   * [Open Technical Communication!](https://alg.manifoldapp.org/read/open-technical-communication/section/67ef90ba-8ca3-4e8e-abb0-0a3966cf2ac7).



   * [Docs for Developers](https://www.amazon.com/dp/1484272161/ref=cm_sw_r_awdo_navT_g_SV4HMY0QJNCGSEZ96T21); An Engineer’s Field Guide to Technical Writing.



   * [The Mayfield Handbook of Technical and Scientific Writing](http://www.mit.edu/course/21/21.guide/toc.htm).



   * [Writing Handbook](https://www.julian.com/guide/write/intro) by Julian Shapiro.



   * [Technical Writing 101: A Real-World Guide to Planning and Writing Technical Content](https://www.gettextbooks.com/isbn/9780970473363/) By Alan S. Pringle, Sarah S. O'keefe.

   

   * [Docs for Developers](https://learning.oreilly.com/library/view/docs-for-developers/9781484272176/html/505277_1_En_BookFrontmatter_OnlinePDF.xhtml)



## Build your Portfolio



#### What a Technical Writing role entails



  * [Sample of Technical Writer responsibilities](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments-to-development-guidelines).



#### These are my recommendations for building a Portfolio



  * Create your Blog and publish as you learn. The first two options don't require you to be technical to set things up;

    * Hashnode

    * Dev.to

    * Create a more personalized website using Wix, Webflow, or WordPress.

    

  * Contribute to Open source Projects.

    * [Technical Writers Guide to Contributing to Open Source](https://edidiongasikpo.com/the-technical-writers-guide-to-contributing-to-open-source-projects) By Edidiong Asikpo.

    

  * Create Your Resume and Cover Letter

    * [Cover Letter Template](https://dillionmegida.com/p/cover-letter-template/) By Dillion Megida.

    * [Careers.google - ](https://careers.google.com/how-we-hire/#step-your-resume)  How we hire



## Find Jobs



  * [Content Writing Jobs](https://contentwritingjobs.com/find-job/technical): Hand-picked writing opportunities to work from home, remotely, freelance, full-time, part-time, contract and internships.

  * [Pocket Writer Job boards List](https://github.com/CynthiaPeter/pocket-writer-job-boards-list).

  * [Smashing Magazine](https://www.smashingmagazine.com/write-for-us/).

  * [CSS Tricks](https://css-tricks.com/guest-posting/).

  * [Educative.io](https://www.educative.io/m/educativeio-edpresso-write-with-us).

  * [Sitepoint](https://www.sitepoint.com/write-for-us/).

  * [Vonage Learn](https://www.learn.vonage.com/spotlight).

  * [Civo](https://www.civo.com/write-for-us).

  * [Airbyte](https://www.airbyte.com/community/write-for-the-community).

  * [Circleci](https://www.circleci.com/blog/authors-program).

  * [Ambassador](https://www.getambassador.io/write-for-us).



### More Learning Resources📘



  📘 This [page](https://www.writethedocs.org/topics/) links to the topics that have been covered by conference talks or in the newsletter for the 'Write The Docs' community.



  📘 [Handling empty characters](https://emptycharacter.com/).



  📘 If you are new to tech and need a basic introduction to computer science. Here are a couple of my favourite resources to get you started: 

  [Harvard CS50 course](https://cs50.harvard.edu/x/2021/weeks/0/).



  📘 [Learn Markdown](https://www.markdownguide.org/getting-started/).



  📀 [Seeing your docs through different eyes:](https://www.youtube.com/watch?v=vj7TyUgBEW8) Mapping doc users experiences By Aaron Collier.



  📀 [What do you look for when hiring technical Writers](https://www.youtube.com/watch?v=tv1DhmUT-Fo) By Dawn Davenport.



  📀 [Code Samples In Documentation](https://www.youtube.com/watch?v=_gtzUpvGfXY) By Brian Murray.



  📀 [Blog Promotion Checklist](https://draft.dev/learn/promotion) By Karl Hughes.



### Learn Git - Version Control



  📘 [Learn Git in a Month of Lunches](https://ng1lib.org/book/2608857/0cb40e).



  📘 [GIT PURR! Git Commands Explained with Cats!](https://girliemac.com/blog/2017/12/26/git-purr/) By Tomomi Imura.



  📘 [A Visual Guide to Version Control](https://betterexplained.com/articles/a-visual-guide-to-version-control/) By Better Explained.

  

### SEO for Technical Writers

  

  🖊 [SEO for beginners: An Introduction to SEO Basics](https://www.searchenginejournal.com/seo-guide/).

  

  🖊 [Search Engine Optimization: A Beginner's Guide from Ahrefs](https://ahrefs.com/seo).

  

  🖊 [The Beginner's Guide to SEO: Rankings and traffic through search engine optimization](https://moz.com/beginners-guide-to-seo).

  

  

### Other Technical Writing Resources



  🔗 [Resources on Technical writing](https://docs.google.com/document/d/1ry9zsI3SFR-wzE69Rqz_z4VPXqIqg1yhkZZNUOKEBH8/edit) covering Transcription, Word Processing, Defi Content Writing, Ux Writing, NFT Content Writing.



### Upskill

As a technical writer, you might find yourself learning on the job. Below, you'll find links to platforms that offer both free and paid courses. I encourage you to spend some time reading and upskilling. Happy learning.



  🔗 [Edx](https://www.edx.org/)

  🔗 [Google Digital Skills](https://learndigital.withgoogle.com/digitalskills/courses)



## Final Notes



Hey stranger, I plan to update this as much as possible. You can contribute if you find something you learned from and think we, too, can learn from.



I am glad you have taken this path, and if you want to talk, send a DM on [Twitter](https://twitter.com/iamCynthiaPeter).



Happy Learning!!!