{"id":14263163,"url":"https://github.com/CynthiaPeter/Technical-Writing-Resources","last_synced_at":"2025-08-13T09:32:20.534Z","repository":{"id":41491922,"uuid":"488525806","full_name":"CynthiaPeter/Technical-Writing-Resources","owner":"CynthiaPeter","description":"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. ","archived":false,"fork":false,"pushed_at":"2024-06-11T20:03:22.000Z","size":64,"stargazers_count":732,"open_issues_count":7,"forks_count":160,"subscribers_count":19,"default_branch":"main","last_synced_at":"2024-11-14T00:39:41.363Z","etag":null,"topics":["documentation","technical","technical-writing","writing-articles"],"latest_commit_sha":null,"homepage":"https://www.cynthiapeter.com/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CynthiaPeter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-04T09:25:19.000Z","updated_at":"2024-11-11T08:38:59.000Z","dependencies_parsed_at":"2024-08-22T13:13:05.338Z","dependency_job_id":"5bd18e62-4526-4d20-b2c5-8db4c2ef9ce0","html_url":"https://github.com/CynthiaPeter/Technical-Writing-Resources","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CynthiaPeter%2FTechnical-Writing-Resources","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CynthiaPeter%2FTechnical-Writing-Resources/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CynthiaPeter%2FTechnical-Writing-Resources/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CynthiaPeter%2FTechnical-Writing-Resources/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CynthiaPeter","download_url":"https://codeload.github.com/CynthiaPeter/Technical-Writing-Resources/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229754489,"owners_count":18119126,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","technical","technical-writing","writing-articles"],"created_at":"2024-08-22T13:02:48.475Z","updated_at":"2025-08-13T09:32:20.504Z","avatar_url":"https://github.com/CynthiaPeter.png","language":null,"funding_links":[],"categories":["documentation"],"sub_categories":[],"readme":"\n![Technical Writing Resources](https://user-images.githubusercontent.com/33583060/179394775-49202628-3949-43e4-91ce-a9d215704aaa.png)\n\n# Technical-Writing-Resources\n\n**Hi there🙌🏾**\n\nI hope you are doing well. \nThis is a compilation of essential links I have encountered as a writer. I hope this helps you too.\n\n## Getting Started\n\n[Technical Writing Roadmap](https://roadmap.sh/technical-writer) By Hackmamba X iChuloo\n\n**Blogs**\n\n  - [Technical Writing - A beginners Guide](https://developers.deepgram.com/blog/2022/03/technical-writing-a-beginners-guide/) By Bekah Hawrot Weigel.\n  - [What is Technical Writing ](https://uxwritinghub.com/what-is-technical-writing/) By UX Writing Hub.\n  - [Everything You need to Know about Technical Writing](https://www.everythingtechnicalwriting.com/everything-you-need-to-know-about-technical-writing/) By Lynda.\n  - [Technical Writing - The what and How](https://edidiongasikpo.com/technical-writing-what-and-how) By Edidiong Asikpo.\n  - [What is Technical Writing?](https://www.instructionalsolutions.com/blog/what-is-technical-writing) by Kara Latz.\n  - [What is Technical Writing](https://technicalwriterhq.com/writing/technical-writing/) By TechnicalWriterHq\n  - [A software developer's guide to Writing](https://theankurtyagi.com/a-software-developers-guide-to-writing/) By Ankur Tyagi\n  - [How to Create Technical Documentation with Examples](https://document360.com/blog/technical-documentation/) By Kingson S\n  - [Software Documentation Best Pratices With Examples](https://helpjuice.com/blog/software-documentation/) By David Oragui\n\n\n**Courses**\n  - [Learn Tech Writing](https://learntechwriting.co/index.html) by Arnab Ghosh.\n  - [Tech Writers Master Class](https://www.udemy.com/course/tech-writers-master-class/) By Janet Underwood.\n \n\n## Types of Documentation You may need to do as a Technical writer:\n\n### API Documentation\n  * [Working with APIs](https://support.knowledgeowl.com/help/working-with-apis) By KnowlegdeOwl.\n  * [Postman Learning center](https://learning.postman.com/docs/publishing-your-api/documenting-your-api/) for API docs.\n  * [Documenting APIs](https://idratherbewriting.com/learnapidoc/) A guide for technical writers and engineers.\n  * [API Docs](https://apidocsfordevs.com/) for Devs By Shalvah.\n  * [Getting Started in API Documentation](http://writeonce.org/starting_as_a_programmer_writer.php) By Robert Delwood.\n  * [How to Read API Documentation](https://www.departmentofproduct.com/blog/how-to-read-api-documentation/) By Richard Holmes\n\n### Learn about APIs\n  * [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.\n  * [An introduction to APIs](https://zapier.com/resources/guides/apis) by Zapier. This course breaks down APIs for beginners.\n\n### Building Documentation site\n* [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\n* [How to build a docs site](https://dev.to/michaelcurrin/how-to-build-a-docs-site-4h42) By  Michael Currin\n\n### Doc-as-code\n* [Docs as Code: A Development Approach to Documentation](https://www.makeuseof.com/docs-as-code-overview/) By Ukeje Chukwuemeriwo Goodness\n* [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\n* [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 \n\n### 4c Documentation Model\n* [Documentation system](https://www.documentation.divio.com/introduction) by Divio\n* [How Docs are Structured](https://www.gatsbyjs.com/contributing/docs-contributions/docs-structure) By Gatsby\n\n\n### Getting Started Guide\n\n  📰 [Getting Started Guide retrospective: ](https://www.knowledgeowl.com/home/getting-started-guide-retrospective) The good, the bad, the ugly – By Kate Mueller\n \n### Articles and Blogs\n\n  🪄 [21 Tips to write better posts for devs](https://semaphoreci.com/blog/tips-to-write-for-developers).\n\n### Guides and FAQs\n\n  * [ReadTheDocs - Writing Documentation Guide](https://docs-guide.readthedocs.io/en/latest/writing/).\n\n### Style Guides\n\nWhen 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:\n\n  * [Microsoft](https://docs.microsoft.com/en-us/style-guide/welcome/).\n  * [Google](https://developers.google.com/style) provides editorial guidelines for writing clear and consistent Google-related developer documentation.\n  * [Diátaxis](https://diataxis.fr/) - A systematic framework for technical documentation authoring.\n  * [Gitlab Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide/).\n  * [Alistapart Style Guide](https://alistapart.com/about/style-guide/).\n  * [Gatsby StyleGuides](https://www.gatsbyjs.com/contributing/gatsby-style-guide/).\n  * The [FreeCodeCamp](https://www.freecodecamp.org/news/developer-news-style-guide/) Publication Style Guide.\n  \n  \n  **Extra:**\n  \n  * [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.\n  \n\n### Defining Tone Of Voice\n\n  * [Monzo](https://monzo.com/tone-of-voice/).\n\n  * [Microsoft's brand voice: ](https://docs.microsoft.com/en-us/style-guide/brand-voice-above-all-simple-human) Above all, simple and human.\n\n  * Atlassian Design System - [Voice and design Principles](https://atlassian.design/content/voice-and-tone-principles).\n\n  * [Shopify Voice and Tone](https://polaris.shopify.com/content/voice-and-tone#navigation).\n\n\n## Tools\n\n  **Technical Writing Tools**\n   * Learn [Adobe frame maker.](https://my.adobeconnect.com/introduction-to-framemaker/)\n   * Learn [Adobe frame maker.](https://my.adobeconnect.com/introduction-to-framemaker/)\n\n  **Productivity and Content Planning**\n\n   * [How I use Notion for my Article and Content Ideas](https://www.youtube.com/watch?v=yxbAX6vTUgc) By Dillion Megida.\n   * [Feedly](https://feedly.com/i/welcome) lets you get the news you want all in one place.\n\n  **Grammar**\n  \n   * [Grammarly](https://app.grammarly.com/) helps you write mistake-free in Gmail, Facebook, Twitter, LinkedIn, and any other app you use.\n\n  **Plagiarism Checker**\n\n   * [Quetext's](https://www.quetext.com/) plagiarism checker analyzes your text to identify plagiarism, resolve other writing issues, and easily build citations.\n  \n  **Paraphrasing Tool**\n\n   *  [Quillbot](https://quillbot.com/) Helps you rewrite and enhance any sentence, paragraph, or article using state-of-the-art AI.\n  \n   * [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. \n  \n  **Graphics**\n \n   * Create cover images for your articles and blog posts using [Canva](canva.com).\n  \n   * [Make drawings, highlights, blurs, on Screenshot](https://annotely.com/).\n  \n   * [Mermaid](https://mermaid-js.github.io/mermaid/#/README) lets you create diagrams and visualizations using text and code.\n  \n **CrossPost**\n \n  → [CrossXpost](https://crossxpost.app/)\n\n  **AI Tools**\n   * [Phind](https://www.phind.com/)\n   * [Chat GPT](https://chat.openai.com/)\n  \n**Extras**   \n\n  → [To check trends](https://trends.google.com/).\n  \n  → [Headline analyzer](https://headlines.coschedule.com/headlines)\n  \n  → [Americans with disability act](https://adata.org/learn-about-ada).\n  \n  → [Writing in plain language](https://www.plainlanguage.gov/law/).\n  \n  → [Inclusive writing for everyone](https://www.witty.works/).\n  \n  → [Passive voice detector](https://datayze.com/passive-voice-detector).\n  \n\n## Best Practices - Developer Experience(DX)\n\n  ✨ [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.\n\n  ✨ [Developer experience in terms of API design](https://apisyouwonthate.com/).\n \n  \n## Community and Newsletters\n\n   * [Technical Typers community](https://discord.gg/2zGqkPVAy6).\n   * [Reddit](https://www.reddit.com/r/technicalwriting/).\n   * [Non Technical in Tech](https://join.slack.com/t/nontechintech/shared_invite/zt-s9eg89md-oa_0xTZpVn2iYZvOoAIhBQ).\n   * [Linkedin Technical Writing Group](https://www.linkedin.com/groups/112571/).\n\n\n**Newsletters📬✉️**\n\n   * [The everything technical writing newsletter](https://www.getrevue.co/profile/_mslinda?subscribe_form=issue-page-header) By Linda Ikechukwu.\n\n   * [Dentry Newsletter](http://subscribe.dentry.io/) By William Imoh: Receive entry-level and intermediate roles in software engineering, design, and product management.\n\n\n**Podcasts🎙🎙**\n\n   * [Thenotboringtechwriter Podcast](https://www.thenotboringtechwriter.com/) By Jacob Moses.\n\n   * [Technical Marketing Handbook](https://www.stitcher.com/show/technical-marketing-handbook).\n\n   * [10 Mins Tech Comm](https://www.stitcher.com/show/10minute-tech-comm).\n\n   * [API THE DOCS podcast](https://apithedocs.org/podcast?page=1).\n\n\n**Books📘📘**\n\n   * [Open Technical Communication!](https://alg.manifoldapp.org/read/open-technical-communication/section/67ef90ba-8ca3-4e8e-abb0-0a3966cf2ac7).\n\n   * [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.\n\n   * [The Mayfield Handbook of Technical and Scientific Writing](http://www.mit.edu/course/21/21.guide/toc.htm).\n\n   * [Writing Handbook](https://www.julian.com/guide/write/intro) by Julian Shapiro.\n\n   * [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.\n   \n   * [Docs for Developers](https://learning.oreilly.com/library/view/docs-for-developers/9781484272176/html/505277_1_En_BookFrontmatter_OnlinePDF.xhtml)\n\n\n## Build your Portfolio\n\n#### What a Technical Writing role entails\n\n  * [Sample of Technical Writer responsibilities](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments-to-development-guidelines).\n\n#### These are my recommendations for building a Portfolio\n\n  * Create your Blog and publish as you learn. The first two options don't require you to be technical to set things up;\n    * Hashnode\n    * Dev.to\n    * Create a more personalized website using Wix, Webflow, or WordPress.\n    \n  * Contribute to Open source Projects.\n    * [Technical Writers Guide to Contributing to Open Source](https://edidiongasikpo.com/the-technical-writers-guide-to-contributing-to-open-source-projects) By Edidiong Asikpo.\n    \n  * Create Your Resume and Cover Letter\n    * [Cover Letter Template](https://dillionmegida.com/p/cover-letter-template/) By Dillion Megida.\n    * [Careers.google - ](https://careers.google.com/how-we-hire/#step-your-resume)  How we hire\n\n\n## Find Jobs\n\n  * [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.\n  * [Pocket Writer Job boards List](https://github.com/CynthiaPeter/pocket-writer-job-boards-list).\n  * [Smashing Magazine](https://www.smashingmagazine.com/write-for-us/).\n  * [CSS Tricks](https://css-tricks.com/guest-posting/).\n  * [Educative.io](https://www.educative.io/m/educativeio-edpresso-write-with-us).\n  * [Sitepoint](https://www.sitepoint.com/write-for-us/).\n  * [Vonage Learn](https://www.learn.vonage.com/spotlight).\n  * [Civo](https://www.civo.com/write-for-us).\n  * [Airbyte](https://www.airbyte.com/community/write-for-the-community).\n  * [Circleci](https://www.circleci.com/blog/authors-program).\n  * [Ambassador](https://www.getambassador.io/write-for-us).\n\n\n### More Learning Resources📘\n\n  📘 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.\n\n  📘 [Handling empty characters](https://emptycharacter.com/).\n\n  📘 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: \n  [Harvard CS50 course](https://cs50.harvard.edu/x/2021/weeks/0/).\n\n  📘 [Learn Markdown](https://www.markdownguide.org/getting-started/).\n\n  📀 [Seeing your docs through different eyes:](https://www.youtube.com/watch?v=vj7TyUgBEW8) Mapping doc users experiences By Aaron Collier.\n\n  📀 [What do you look for when hiring technical Writers](https://www.youtube.com/watch?v=tv1DhmUT-Fo) By Dawn Davenport.\n\n  📀 [Code Samples In Documentation](https://www.youtube.com/watch?v=_gtzUpvGfXY) By Brian Murray.\n\n  📀 [Blog Promotion Checklist](https://draft.dev/learn/promotion) By Karl Hughes.\n\n\n### Learn Git - Version Control\n\n  📘 [Learn Git in a Month of Lunches](https://ng1lib.org/book/2608857/0cb40e).\n\n  📘 [GIT PURR! Git Commands Explained with Cats!](https://girliemac.com/blog/2017/12/26/git-purr/) By Tomomi Imura.\n\n  📘 [A Visual Guide to Version Control](https://betterexplained.com/articles/a-visual-guide-to-version-control/) By Better Explained.\n  \n### SEO for Technical Writers\n  \n  🖊 [SEO for beginners: An Introduction to SEO Basics](https://www.searchenginejournal.com/seo-guide/).\n  \n  🖊 [Search Engine Optimization: A Beginner's Guide from Ahrefs](https://ahrefs.com/seo).\n  \n  🖊 [The Beginner's Guide to SEO: Rankings and traffic through search engine optimization](https://moz.com/beginners-guide-to-seo).\n  \n  \n### Other Technical Writing Resources\n\n  🔗 [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.\n\n### Upskill\nAs 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.\n\n  🔗 [Edx](https://www.edx.org/)\n  🔗 [Google Digital Skills](https://learndigital.withgoogle.com/digitalskills/courses)\n\n## Final Notes\n\nHey 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.\n\nI am glad you have taken this path, and if you want to talk, send a DM on [Twitter](https://twitter.com/iamCynthiaPeter).\n\n\nHappy Learning!!!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCynthiaPeter%2FTechnical-Writing-Resources","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCynthiaPeter%2FTechnical-Writing-Resources","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCynthiaPeter%2FTechnical-Writing-Resources/lists"}