From 6fe66fb91c8916b28abe31d93d9fdff01a585685 Mon Sep 17 00:00:00 2001 From: Teri Eyenike Date: Thu, 26 May 2022 16:05:39 +0100 Subject: [PATCH 01/20] Add: capitalize my title for heading --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 7735253..1235abe 100644 --- a/README.md +++ b/README.md @@ -107,6 +107,7 @@ Communities can provide valuable learning opportunities, growth, mentorship and - [GoFullPage - Full Page Screen Capture](https://chrome.google.com/webstore/detail/gofullpage-full-page-scre/fdpohaocaechififmbbbbbknoalclacl?hl=en) ~ A chrome extension taht allows you take full page screenshot of your current browser window. - [Carbon](https://carbon.now.sh/) ~ Carbon is the easiest way to create and share beautiful images of your source code. - [Isitwp](https://www.isitwp.com/headline-analyzer) ~ IsItWP Headline Analyzer tool helps you write headlines that drive traffic, shares and rank better in search results. +- [Capitalize my title](https://capitalizemytitle.com/) ~ Making title capitalization easy for your writing ## Who pays technical writers From 62c7850005832d40f51a196a2cf2d6eaa0d28da8 Mon Sep 17 00:00:00 2001 From: Teri Eyenike Date: Thu, 26 May 2022 16:16:51 +0100 Subject: [PATCH 02/20] Add: AI tool to turn text to engaging writing --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 7735253..80af407 100644 --- a/README.md +++ b/README.md @@ -107,6 +107,7 @@ Communities can provide valuable learning opportunities, growth, mentorship and - [GoFullPage - Full Page Screen Capture](https://chrome.google.com/webstore/detail/gofullpage-full-page-scre/fdpohaocaechififmbbbbbknoalclacl?hl=en) ~ A chrome extension taht allows you take full page screenshot of your current browser window. - [Carbon](https://carbon.now.sh/) ~ Carbon is the easiest way to create and share beautiful images of your source code. - [Isitwp](https://www.isitwp.com/headline-analyzer) ~ IsItWP Headline Analyzer tool helps you write headlines that drive traffic, shares and rank better in search results. +- [Wordtune](https://www.wordtune.com/) ~ Wordtune turns text into concise, engaging, well-written messages. ## Who pays technical writers From 1114829664b96121e442d22d45f4cbcf4cbdf9a7 Mon Sep 17 00:00:00 2001 From: Teri Eyenike Date: Fri, 27 May 2022 13:29:01 +0100 Subject: [PATCH 03/20] Add: tools to be efficient in writing --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index cd5a78c..6911c25 100644 --- a/README.md +++ b/README.md @@ -109,6 +109,11 @@ Communities can provide valuable learning opportunities, growth, mentorship and - [Isitwp](https://www.isitwp.com/headline-analyzer) ~ IsItWP Headline Analyzer tool helps you write headlines that drive traffic, shares and rank better in search results. - [Capitalize my title](https://capitalizemytitle.com/) ~ Making title capitalization easy for your writing - [Wordtune](https://www.wordtune.com/) ~ Wordtune turns text into concise, engaging, well-written messages. +- [Headline Analyzer](https://coschedule.com/headline-analyzer) ~ Write Headlines That Drive Traffic, Shares, And Search Results. +- [Title Generator](https://tweakyourbiz.com/title-generator) ~ Generate great titles for articles and blog posts. +- [SEO writing assistant](https://www.semrush.com/swa/) ~ A smart writing editor that helps you optimize your copy for engagement and SEO. +- [HackMD](https://hackmd.io/) ~ A collaborative markdown editor for sharing your articles and getting feedback from others. +- [Copyscape](https://www.copyscape.com/) ~ Plagiarism checker ## Who pays technical writers From 47816961ec6e0f9d69e8143196bae74df8f80098 Mon Sep 17 00:00:00 2001 From: ksound22 Date: Sat, 28 May 2022 17:39:52 +0100 Subject: [PATCH 04/20] Added Strip's Markdoc to tools --- CODE_OF_CONDUCT.md | 256 +++++++++++++++--------------- CONTRIBUTING.md | 64 ++++---- LICENSE.md | 44 +++--- README.md | 378 ++++++++++++++++++++++----------------------- 4 files changed, 369 insertions(+), 373 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index ce7cf24..7173027 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,128 +1,128 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -We as members, contributors, and leaders pledge to make participation in our -community a harassment-free experience for everyone, regardless of age, body -size, visible or invisible disability, ethnicity, sex characteristics, gender -identity and expression, level of experience, education, socio-economic status, -nationality, personal appearance, race, religion, or sexual identity -and orientation. - -We pledge to act and interact in ways that contribute to an open, welcoming, -diverse, inclusive, and healthy community. - -## Our Standards - -Examples of behavior that contributes to a positive environment for our -community include: - -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, - and learning from the experience -* Focusing on what is best not just for us as individuals, but for the - overall community - -Examples of unacceptable behavior include: - -* The use of sexualized language or imagery, and sexual attention or - advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email - address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Enforcement Responsibilities - -Community leaders are responsible for clarifying and enforcing our standards of -acceptable behavior and will take appropriate and fair corrective action in -response to any behavior that they deem inappropriate, threatening, offensive, -or harmful. - -Community leaders have the right and responsibility to remove, edit, or reject -comments, commits, code, wiki edits, issues, and other contributions that are -not aligned to this Code of Conduct, and will communicate reasons for moderation -decisions when appropriate. - -## Scope - -This Code of Conduct applies within all community spaces, and also applies when -an individual is officially representing the community in public spaces. -Examples of representing our community include using an official e-mail address, -posting via an official social media account, or acting as an appointed -representative at an online or offline event. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at -hardeydoyeen1@gmail.com. -All complaints will be reviewed and investigated promptly and fairly. - -All community leaders are obligated to respect the privacy and security of the -reporter of any incident. - -## Enforcement Guidelines - -Community leaders will follow these Community Impact Guidelines in determining -the consequences for any action they deem in violation of this Code of Conduct: - -### 1. Correction - -**Community Impact**: Use of inappropriate language or other behavior deemed -unprofessional or unwelcome in the community. - -**Consequence**: A private, written warning from community leaders, providing -clarity around the nature of the violation and an explanation of why the -behavior was inappropriate. A public apology may be requested. - -### 2. Warning - -**Community Impact**: A violation through a single incident or series -of actions. - -**Consequence**: A warning with consequences for continued behavior. No -interaction with the people involved, including unsolicited interaction with -those enforcing the Code of Conduct, for a specified period of time. This -includes avoiding interactions in community spaces as well as external channels -like social media. Violating these terms may lead to a temporary or -permanent ban. - -### 3. Temporary Ban - -**Community Impact**: A serious violation of community standards, including -sustained inappropriate behavior. - -**Consequence**: A temporary ban from any sort of interaction or public -communication with the community for a specified period of time. No public or -private interaction with the people involved, including unsolicited interaction -with those enforcing the Code of Conduct, is allowed during this period. -Violating these terms may lead to a permanent ban. - -### 4. Permanent Ban - -**Community Impact**: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behavior, harassment of an -individual, or aggression toward or disparagement of classes of individuals. - -**Consequence**: A permanent ban from any sort of public interaction within -the community. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 2.0, available at -https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. - -Community Impact Guidelines were inspired by [Mozilla's code of conduct -enforcement ladder](https://github.com/mozilla/diversity). - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see the FAQ at -https://www.contributor-covenant.org/faq. Translations are available at -https://www.contributor-covenant.org/translations. +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +hardeydoyeen1@gmail.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5a0958f..c12831e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,33 +1,33 @@ -🎉🥳Yayyyy!!!! Thanks for taking time to contribute to this open source project. - -Inorder to contribute to this project, there are some guidelines to be followed and you can make a pull request to make additional changes. - - -## How do I make contributions - -All forms of contributions are welcomed. Here are some ways to get started with making contributions - -- Fixing typos in the repository -- Submit a typo/bug in GitHub Issues. -- Add new suggestions to the outline -- Add links to resources . - -## Guidelines for contributing - -- Pull requests should be descriptive -- Proofread for spelling and grammar errors before raising a pull request. -- Use desriptive commit messages. -- If you're suggesting a very big change, kindly open an issue first. - -## How do I submit a Pull Request (PR)? -Contributing follows this workflow: - -- Fork this project repository. -- Clone the forked repository to your computer. -- Create and switch into a new branch. -- Edit or create an entry and commit the changes. -- Make a PR to merge your fork with this repo. - -
- +🎉🥳Yayyyy!!!! Thanks for taking time to contribute to this open source project. + +Inorder to contribute to this project, there are some guidelines to be followed and you can make a pull request to make additional changes. + + +## How do I make contributions + +All forms of contributions are welcomed. Here are some ways to get started with making contributions + +- Fixing typos in the repository +- Submit a typo/bug in GitHub Issues. +- Add new suggestions to the outline +- Add links to resources . + +## Guidelines for contributing + +- Pull requests should be descriptive +- Proofread for spelling and grammar errors before raising a pull request. +- Use desriptive commit messages. +- If you're suggesting a very big change, kindly open an issue first. + +## How do I submit a Pull Request (PR)? +Contributing follows this workflow: + +- Fork this project repository. +- Clone the forked repository to your computer. +- Create and switch into a new branch. +- Edit or create an entry and commit the changes. +- Make a PR to merge your fork with this repo. + +
+

Made with ❤️ by Damilola Ezekiel

\ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md index 238056f..e8f7ac8 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,23 +1,23 @@ -MIT License - -Copyright (c) 2022 Damilola Ezekiel - - - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +MIT License + +Copyright (c) 2022 Damilola Ezekiel + + + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 6911c25..791af9c 100644 --- a/README.md +++ b/README.md @@ -1,191 +1,187 @@ -
- -
- -#### Technical writing is a form of communication that helps users solve problems with technology. As a technical writer, sharing your knowledge and experience with people helps you affirm that you have a solid understanding of the technology you're writing about. - - - -## What is Technical Writing? - - ->Technical writing is a type of writing where the author is writing about a particular subject that requires direction, instruction, or explanation. This style of writing has a very different purpose and different characteristics than other writing styles. ~ [YourDictionary](https://grammar.yourdictionary.com/word-definitions/definition-of-technical-writing.html) - -## Outline - - [Resources](#resources) - - [Books](#books) - - [Articles](#articles) - - [Courses](#Courses) - - [Youtube](#Youtube) - - [Communities](#communities) - - [Tools](#tools) - - [Who pays technical writers](#Who-pays-technical-writers) - - [Open source projects](#open-source-projects) - - [Awesome technical writers](#Awesome-technical-writers) - - [Blogs to follow for awesome writing contents](#Blogs-to-follow-for-awesome-writing-contents) - - [Preparing for technical writing interviews](#Preparing-for-technical-writing-interviews) - - [Sites to publish articles](#sites-to-publish-your-articles) - - [Job boards for technical writing roles](#Job-boards-for-technical-writing-roles) - -## Resources -This repository contains different technical writing resources that has been gathered from all around the internet - - ## Articles - - [How to Get Started with Technical Writing](https://www.samjulien.com/how-to-get-started-with-technical-writing) - - [How to become a technical writer](https://www.freecodecamp.org/news/how-to-become-a-technical-writer/) - - [Technical Writing for Beginners – An A-Z Guide to Tech Blogging Basics](https://www.freecodecamp.org/news/technical-writing-for-beginners/) - - [Technical Writing: What and How?](https://edidiongasikpo.com/technical-writing-what-and-how) - - [How to Learn Technical Writing for Free](https://medium.com/technical-writing-is-easy/how-to-learn-technical-writing-for-free-c16d191b3cee) - - [Getting Started with Technical Writing](https://dillionmegida.com/p/getting-started-with-technical-writing/) - - [Advice for Technical Writing](https://css-tricks.com/advice-for-technical-writing/) - - [How To Write Content That Readers Will Read Based On Learnings From User Psychology](https://www.everythingtechnicalwriting.com/how-to-write-content-that-readers-will-read/) - - [How To Create A Technical Writing Portfolio](https://www.everythingtechnicalwriting.com/technical-writing-portfolio/) - - [Writing Tips for Software Developers – How to Become a Better Tech Writer](https://www.freecodecamp.org/news/writing-tips-software-developers/) - - [11 Best Practices for Writing API Documentation](https://treblle.com/blog/11-best-practices-for-writing-api-documentation) - - [Technical Writing vs Technical Blogging](https://lo-victoria.com/what-you-need-to-know-about-technical-writing-vs-technical-blogging#cknj3ppa30d7m2ks14c8o0vnf) - - -## Books -- [Writing Well](https://www.julian.com/guide/write/intro) ~ Julian Shapiro -- [Technical Writing, Simplified](https://www.amazon.com/Technical-Writing-Simplified-Nell-Johnson/dp/154326848X/ref=sr_1_1?crid=NUEHTLJWKLMN&keywords=Technical+Writing%2C+Simplified&qid=1651614066&s=books&sprefix=technical+writing%2C+simplified%2Cstripbooks-intl-ship%2C416&sr=1-1) ~ Nell Johnson -- [Writing for Sotware Developers](https://philipkiely.gumroad.com/l/uZPZU) ~ Philip Kiely -- [Technical Writing For Dummies](https://www.amazon.com/Technical-Writing-Dummies-Sheryl-Lindsell-Roberts/dp/0764553089) ~ Sheryl Lindsell-Roberts - -- [Docs for Developers: An Engineer’s Field Guide to Technical Writing](https://www.amazon.com/Docs-Developers-Engineers-Technical-Writing/dp/1484272161/) ~ Jared Bhatti -- [Modern Technical Writing: An Introduction to Software Documentation ](https://www.amazon.com/Modern-Technical-Writing-Introduction-Documentation-ebook/dp/B01A2QL9SS/ref=sr_1_1?crid=Y7S35M7LVXWE&dchild=1&keywords=modern+technical+writing&qid=1595414707&sprefix=modern+technical+%2Caps%2C346&sr=8-1) ~ Andrew Etter -- [Everybody Writes: Your Go-To Guide to Creating Ridiculously Good Content](https://www.amazon.com/gp/product/1118905555/ref=as_li_tl?ie=UTF8&tag=techlife09-20&camp=1789&creative=9325&linkCode=as2&creativeASIN=1118905555&linkId=5a9769d7dc1a62419abb83e6b451ac96) ~ Ann Handley -- [On Writing Well](https://www.amazon.com/gp/product/0060891548/ref=as_li_tl?ie=UTF8&tag=techlife09-20&camp=1789&creative=9325&linkCode=as2&creativeASIN=0060891548&linkId=27bd72a8da3fb242b39dbe4edb470daf) ~ William Zinsser -- [Technical Communication](https://www.amazon.com/Technical-Communication-Mike-Markel-dp-1319245005/dp/1319245005/ref=dp_ob_image_bk) ~ Mike Markel - - -## Courses - -- [Technical Writing Courses for Engineers](https://developers.google.com/tech-writing) -- [Technical Writing: How to Write Software Documentation](https://www.udemy.com/course/start-your-career-as-user-assistance-developer/) -- [Learn API Technical Writing: JSON and XML for Writers](https://www.udemy.com/course/api-documentation-1-json-and-xml/) -- [The Art of API Documentation](https://www.udemy.com/course/the-art-of-api-documentation/) -- [Documenting APIs: A guide for technical writers and engineers](https://idratherbewriting.com/learnapidoc/) -- [Technical Writer Certification Course](https://technicalwriter.teachable.com/p/technical-writing-certification) ~ Technical Writer Certification Course was created for aspiring technical writers or people who want to brush up on their technical writing skills. -- [SEO FOR DEVS](https://seofordevs.com/) ~ SEO FOR DEVS is a free 2 weeks course that helps people discover your tech blog or side project in a systematic way -- [API Documentation for Developers](https://apidocsfordevs.com/) ~ A hands-on guide to creating and maintaining API documentation. - -## Youtube - -- [DocToHelpTV](https://www.youtube.com/user/DocToHelpTV/videos) -- [Technical Writer HQ](youtube.com/channel/UCjMnGjosWhBxYtumwhQLZmA/videos) -- [Amruta Ranade](https://www.youtube.com/channel/UCKsaZMjb3lsLe5YtasDifuA) -- [William Smith](https://www.youtube.com/watch?v=amKDhaIlyOc) -- [How to become a Technical Writer | Skills & Career Growth](youtube.com/watch?v=8l2KJXIBpB0) - - -## Communities - -Communities can provide valuable learning opportunities, growth, mentorship and career advancement. Connecting with people of similar interest is one of the reasons why people join communities. Here are some of the communities that technical writers can join: - -- [Write the Docs](https://www.writethedocs.org/) -- [Linkedin Technical Writing Community](https://www.linkedin.com/groups/13705342/) -- [Global Writers Community](https://web.facebook.com/groups/technicalwriterjobs/?_rdc=1&_rdr) -- [API Documentation Group](https://www.linkedin.com/groups/3709151/) -- [Technical Writer Forum](https://www.linkedin.com/groups/112571/) -- [Hashnode](https://discord.com/invite/hashnode) -- [The Good Docs Project Community](https://thegooddocsproject.dev/community/) -- [Techwriters.dev](https://techwriters.dev/) -- [r/technicalwriting](https://www.reddit.com/r/technicalwriting/) - -## Tools - -- [Canva](https://www.canva.com/) ~ Canva is a graphic design platform, used to create social media graphics, presentations, posters, documents and other visual content. -- [Removebg](https://www.remove.bg/) ~ A tools that is used to remove image backgrounds. -- [Markdown](https://daringfireball.net/projects/markdown/) ~ Markdown is a text-to-HTML conversion tool for web writers. -- [AsciiDoc](https://asciidoc.org/) ~ AsciiDoc is a lightweight and semantic markup language primarily designed for writing technical documentation. -- [Denigma](https://denigma.app/) ~ Denigma is a tool that explains code in understandable english. -- [Grammarly](https://app.grammarly.com/) ~ Grammarly is a typing assistant that reviews spelling, grammar, punctuation, clarity, engagement, and delivery mistakes. -- [Hemingway App ](https://hemingwayapp.com/) ~ The Hemingway App is a web and desktop app that can improve your writing style and touch up your content. -- [Quillbot AI](https://quillbot.com/) ~ Quillbot AI is a multi-purpose writing tool that can assist in improving your writing style. Some of its products are Paraphraser, Grammar Checker, Plagiarism Checker, Co-Writer, Summarizer, Citation Generator, and Word Counter.  -- [Notion](https://www.notion.so/) ~ Notion is an all-in-one workspace for your notes, tasks, wikis, and databases. It is a tool you can use to organize your thoughts, projects, and information. -- [Dropbox Paper](https://www.dropbox.com/paper) ~ Dropbox Paper is an online document workspace, where you can organize and display text, media, and files all in one place. -- [GoFullPage - Full Page Screen Capture](https://chrome.google.com/webstore/detail/gofullpage-full-page-scre/fdpohaocaechififmbbbbbknoalclacl?hl=en) ~ A chrome extension taht allows you take full page screenshot of your current browser window. -- [Carbon](https://carbon.now.sh/) ~ Carbon is the easiest way to create and share beautiful images of your source code. -- [Isitwp](https://www.isitwp.com/headline-analyzer) ~ IsItWP Headline Analyzer tool helps you write headlines that drive traffic, shares and rank better in search results. -- [Capitalize my title](https://capitalizemytitle.com/) ~ Making title capitalization easy for your writing -- [Wordtune](https://www.wordtune.com/) ~ Wordtune turns text into concise, engaging, well-written messages. -- [Headline Analyzer](https://coschedule.com/headline-analyzer) ~ Write Headlines That Drive Traffic, Shares, And Search Results. -- [Title Generator](https://tweakyourbiz.com/title-generator) ~ Generate great titles for articles and blog posts. -- [SEO writing assistant](https://www.semrush.com/swa/) ~ A smart writing editor that helps you optimize your copy for engagement and SEO. -- [HackMD](https://hackmd.io/) ~ A collaborative markdown editor for sharing your articles and getting feedback from others. -- [Copyscape](https://www.copyscape.com/) ~ Plagiarism checker - -## Who pays technical writers - -Writing technical contents for organizations and publications is an excellent way to earn extra income. This way, you learn a lot, then share your knowledge and get paid. Check out these compiled list for organizations that pays technical writers. - -- [Community writer program](https://github.com/malgamves/CommunityWriterPrograms) -- [Get Paid to Write for These 45+ Websites](https://blog.idrisolubisi.com/get-paid-to-write-for-these-45-websites) -- [Publications That Pay You To Write Technical Articles](https://catalins.tech/websites-that-pay-you-to-write-technical-articles) - -## Open Source Projects - -Contributing to open source can be a rewarding way to learn, teach, and build experience in just about any skill you can imagine. A lot of peole contribute to open source for different reasons and the vital one which is improving one's skillset. - -Here are some articles to help you understand how to contribute to open source projects. - - -- [The Technical Writers Guide to Contributing to Open Source Projects](https://edidiongasikpo.com/the-technical-writers-guide-to-contributing-to-open-source-projects) -- [How to Contribute to Open-Source as a Technical Writer](https://javascript.plainenglish.io/how-to-contribute-to-open-source-as-a-technical-writer-bb708245480c) -- [4 tips to becoming a technical writer with open source contributions](https://opensource.com/article/21/11/technical-writing-open-source) -- [Getting started with Open Source as a Technical Writer](https://amara.hashnode.dev/getting-started-with-open-source-as-a-technical-writer) - -#### Open Source Projects/Programs Technical Writers Can Contribute To - -- [Codecademy Docs](https://www.codecademy.com/resources/docs) ~ Docs is a community-driven collection of code documentation for popular programming languages and frameworks. -- [The Good Docs Project](https://thegooddocsproject.dev/) ~ The Good Docs Project is a community working together to create the templates, tools, and resources to improve the overall quality of documentation in OSS and beyond. -- [Google Season of Docs](https://developers.google.com/season-of-docs) ~ Season of Docs provides support for open source projects to improve their documentation and gives professional technical writers an opportunity to gain experience in open source. -- [Hacktoberfest](https://hacktoberfest.digitalocean.com/) ~ Hacktoberfest is a yearly event to encourage people to contribute to open source in October. -- [The GNOME Documentation Project](https://wiki.gnome.org/DocumentationProject) - - -## Blogs to follow for awesome writing contents - -| Technical Writers | Blogs | Twitter Handle| -| :-----------| ----------- | -------------------| -| Damilola Ezekiel | https://dharmelolar.hashnode.dev| [@that_yhemmygirl](https://twitter.com/that_yhemmygirl) -| Tom Johnson | https://idratherbewriting.com/|[@tomjohnson](https://twitter.com/tomjohnson) -| Kesi Parker | https://medium.com/@kesiparker| [@ParkerKesi](https://twitter.com/ParkerKesi) -| Tania Rascia | https://tania.dev/| [@taniarascia](https://twitter.com/taniarascia) -| Dillion Megida | https://writing.dillionmegida.com/| [@iamdillion](https://twitter.com/iamdillion) -| Linda Ikechukwu| https://www.everythingtechnicalwriting.com| [_MsLinda](https://twitter.com/_MsLinda) -| Amruta Ranade| https://dev.to/amrutaranade | [@AmrutaRanade](https://twitter.com/AmrutaRanade) - -## Preparing for technical writing interviews -There are several tips that can help you land an interview but some of the important ones are having a well tailored resume and cover letters. Check out these cover letter templates and tips to help you land your next interview: - -- [Cover Letter Template for your next job ](https://dillionmegida.com/p/cover-letter-template/) -- [How to Write an Enticing Cover Letter](https://ruthikegah.xyz/how-to-write-an-enticing-cover-letter) -- [How to Write a Technical Writer Resume [+Examples]](https://technicalwriterhq.com/technical-writer-resume/) -- [Best Technical Writer Cover Letter Example and Format ](https://technicalwriterhq.com/technical-writer-cover-letter/) - -Here are some resources to technical writing interview questions to help you prepare for your next interview. - -- [12 Technical Writer Interview Questions and Answers](https://technicalwriterhq.com/technical-writer-interview-questions/) -- [Google Technical Writer Interview Questions](https://technicalwriterhq.com/google-technical-writer-interview-questions/) -- [Technical Writing Job Interview](https://www.youtube.com/watch?v=cqaEgMv2JAg) - -## Sites to publish articles - -- [Hashnode](https://hashnode.com/) ~ Hashnode is a free developer blogging platform to help you share your ideas with people in tech, developers, and engineers. -- [Medium](https://medium.com/) ~ Medium is a social publishing platform with lots of users and you can publish diverse contents and ideas. -- [Dev.to](https://dev.to/) ~ Dev.to is where programmers share ideas and help each other grow. It is an online community for sharing and discovering great ideas. -- [Mirror.xyz](https://mirror.xyz/) ~ Mirror.xyz is a publishing platform for writers that leverages cryptocurrency and blockchain technology. -- [Freecodecamp](https://www.freecodecamp.org/news/how-to-write-for-freecodecamp/) ~ FreeCodeCamp is a non-profit organization that consists of an interactive learning web platform, an online community forum, chat rooms, online publications and local organizations that intend to make learning web development accessible to anyone. - - -## Job Boards For Technical Writing roles - -- [Startup.jobs](https://startup.jobs/?q=Technical+writer&remote=true&utm_campaign=Everything+Technical+Writing+Newsletter&utm_medium=email&utm_source=Revue+newsletter) -- [Angel.co](https://angel.co/jobs) -- [Content Writing Jobs](https://contentwritingjobs.com/) - - -## - -

Made with ❤️ by Damilola Ezekiel

+
+ +
+ +#### Technical writing is a form of communication that helps users solve problems with technology. As a technical writer, sharing your knowledge and experience with people helps you affirm that you have a solid understanding of the technology you're writing about. + +## What is Technical Writing? + +> Technical writing is a type of writing where the author is writing about a particular subject that requires direction, instruction, or explanation. This style of writing has a very different purpose and different characteristics than other writing styles. ~ [YourDictionary](https://grammar.yourdictionary.com/word-definitions/definition-of-technical-writing.html) + +## Outline + +- [Resources](#resources) + - [Books](#books) + - [Articles](#articles) + - [Courses](#Courses) + - [Youtube](#Youtube) +- [Communities](#communities) +- [Tools](#tools) +- [Who pays technical writers](#Who-pays-technical-writers) +- [Open source projects](#open-source-projects) +- [Awesome technical writers](#Awesome-technical-writers) +- [Blogs to follow for awesome writing contents](#Blogs-to-follow-for-awesome-writing-contents) +- [Preparing for technical writing interviews](#Preparing-for-technical-writing-interviews) +- [Sites to publish articles](#sites-to-publish-your-articles) +- [Job boards for technical writing roles](#Job-boards-for-technical-writing-roles) + +## Resources + +This repository contains different technical writing resources that has been gathered from all around the internet + +## Articles + +- [How to Get Started with Technical Writing](https://www.samjulien.com/how-to-get-started-with-technical-writing) +- [How to become a technical writer](https://www.freecodecamp.org/news/how-to-become-a-technical-writer/) +- [Technical Writing for Beginners – An A-Z Guide to Tech Blogging Basics](https://www.freecodecamp.org/news/technical-writing-for-beginners/) +- [Technical Writing: What and How?](https://edidiongasikpo.com/technical-writing-what-and-how) +- [How to Learn Technical Writing for Free](https://medium.com/technical-writing-is-easy/how-to-learn-technical-writing-for-free-c16d191b3cee) +- [Getting Started with Technical Writing](https://dillionmegida.com/p/getting-started-with-technical-writing/) +- [Advice for Technical Writing](https://css-tricks.com/advice-for-technical-writing/) +- [How To Write Content That Readers Will Read Based On Learnings From User Psychology](https://www.everythingtechnicalwriting.com/how-to-write-content-that-readers-will-read/) +- [How To Create A Technical Writing Portfolio](https://www.everythingtechnicalwriting.com/technical-writing-portfolio/) +- [Writing Tips for Software Developers – How to Become a Better Tech Writer](https://www.freecodecamp.org/news/writing-tips-software-developers/) +- [11 Best Practices for Writing API Documentation](https://treblle.com/blog/11-best-practices-for-writing-api-documentation) +- [Technical Writing vs Technical Blogging](https://lo-victoria.com/what-you-need-to-know-about-technical-writing-vs-technical-blogging#cknj3ppa30d7m2ks14c8o0vnf) + +## Books + +- [Writing Well](https://www.julian.com/guide/write/intro) ~ Julian Shapiro +- [Technical Writing, Simplified](https://www.amazon.com/Technical-Writing-Simplified-Nell-Johnson/dp/154326848X/ref=sr_1_1?crid=NUEHTLJWKLMN&keywords=Technical+Writing%2C+Simplified&qid=1651614066&s=books&sprefix=technical+writing%2C+simplified%2Cstripbooks-intl-ship%2C416&sr=1-1) ~ Nell Johnson +- [Writing for Sotware Developers](https://philipkiely.gumroad.com/l/uZPZU) ~ Philip Kiely +- [Technical Writing For Dummies](https://www.amazon.com/Technical-Writing-Dummies-Sheryl-Lindsell-Roberts/dp/0764553089) ~ Sheryl Lindsell-Roberts + +- [Docs for Developers: An Engineer’s Field Guide to Technical Writing](https://www.amazon.com/Docs-Developers-Engineers-Technical-Writing/dp/1484272161/) ~ Jared Bhatti +- [Modern Technical Writing: An Introduction to Software Documentation ](https://www.amazon.com/Modern-Technical-Writing-Introduction-Documentation-ebook/dp/B01A2QL9SS/ref=sr_1_1?crid=Y7S35M7LVXWE&dchild=1&keywords=modern+technical+writing&qid=1595414707&sprefix=modern+technical+%2Caps%2C346&sr=8-1) ~ Andrew Etter +- [Everybody Writes: Your Go-To Guide to Creating Ridiculously Good Content](https://www.amazon.com/gp/product/1118905555/ref=as_li_tl?ie=UTF8&tag=techlife09-20&camp=1789&creative=9325&linkCode=as2&creativeASIN=1118905555&linkId=5a9769d7dc1a62419abb83e6b451ac96) ~ Ann Handley +- [On Writing Well](https://www.amazon.com/gp/product/0060891548/ref=as_li_tl?ie=UTF8&tag=techlife09-20&camp=1789&creative=9325&linkCode=as2&creativeASIN=0060891548&linkId=27bd72a8da3fb242b39dbe4edb470daf) ~ William Zinsser +- [Technical Communication](https://www.amazon.com/Technical-Communication-Mike-Markel-dp-1319245005/dp/1319245005/ref=dp_ob_image_bk) ~ Mike Markel + +## Courses + +- [Technical Writing Courses for Engineers](https://developers.google.com/tech-writing) +- [Technical Writing: How to Write Software Documentation](https://www.udemy.com/course/start-your-career-as-user-assistance-developer/) +- [Learn API Technical Writing: JSON and XML for Writers](https://www.udemy.com/course/api-documentation-1-json-and-xml/) +- [The Art of API Documentation](https://www.udemy.com/course/the-art-of-api-documentation/) +- [Documenting APIs: A guide for technical writers and engineers](https://idratherbewriting.com/learnapidoc/) +- [Technical Writer Certification Course](https://technicalwriter.teachable.com/p/technical-writing-certification) ~ Technical Writer Certification Course was created for aspiring technical writers or people who want to brush up on their technical writing skills. +- [SEO FOR DEVS](https://seofordevs.com/) ~ SEO FOR DEVS is a free 2 weeks course that helps people discover your tech blog or side project in a systematic way +- [API Documentation for Developers](https://apidocsfordevs.com/) ~ A hands-on guide to creating and maintaining API documentation. + +## Youtube + +- [DocToHelpTV](https://www.youtube.com/user/DocToHelpTV/videos) +- [Technical Writer HQ](youtube.com/channel/UCjMnGjosWhBxYtumwhQLZmA/videos) +- [Amruta Ranade](https://www.youtube.com/channel/UCKsaZMjb3lsLe5YtasDifuA) +- [William Smith](https://www.youtube.com/watch?v=amKDhaIlyOc) +- [How to become a Technical Writer | Skills & Career Growth](youtube.com/watch?v=8l2KJXIBpB0) + +## Communities + +Communities can provide valuable learning opportunities, growth, mentorship and career advancement. Connecting with people of similar interest is one of the reasons why people join communities. Here are some of the communities that technical writers can join: + +- [Write the Docs](https://www.writethedocs.org/) +- [Linkedin Technical Writing Community](https://www.linkedin.com/groups/13705342/) +- [Global Writers Community](https://web.facebook.com/groups/technicalwriterjobs/?_rdc=1&_rdr) +- [API Documentation Group](https://www.linkedin.com/groups/3709151/) +- [Technical Writer Forum](https://www.linkedin.com/groups/112571/) +- [Hashnode](https://discord.com/invite/hashnode) +- [The Good Docs Project Community](https://thegooddocsproject.dev/community/) +- [Techwriters.dev](https://techwriters.dev/) +- [r/technicalwriting](https://www.reddit.com/r/technicalwriting/) + +## Tools + +- [Canva](https://www.canva.com/) ~ Canva is a graphic design platform, used to create social media graphics, presentations, posters, documents and other visual content. +- [Removebg](https://www.remove.bg/) ~ A tools that is used to remove image backgrounds. +- [Markdown](https://daringfireball.net/projects/markdown/) ~ Markdown is a text-to-HTML conversion tool for web writers. +- [AsciiDoc](https://asciidoc.org/) ~ AsciiDoc is a lightweight and semantic markup language primarily designed for writing technical documentation. +- [Denigma](https://denigma.app/) ~ Denigma is a tool that explains code in understandable english. +- [Grammarly](https://app.grammarly.com/) ~ Grammarly is a typing assistant that reviews spelling, grammar, punctuation, clarity, engagement, and delivery mistakes. +- [Hemingway App ](https://hemingwayapp.com/) ~ The Hemingway App is a web and desktop app that can improve your writing style and touch up your content. +- [Quillbot AI](https://quillbot.com/) ~ Quillbot AI is a multi-purpose writing tool that can assist in improving your writing style. Some of its products are Paraphraser, Grammar Checker, Plagiarism Checker, Co-Writer, Summarizer, Citation Generator, and Word Counter. +- [Notion](https://www.notion.so/) ~ Notion is an all-in-one workspace for your notes, tasks, wikis, and databases. It is a tool you can use to organize your thoughts, projects, and information. +- [Dropbox Paper](https://www.dropbox.com/paper) ~ Dropbox Paper is an online document workspace, where you can organize and display text, media, and files all in one place. +- [GoFullPage - Full Page Screen Capture](https://chrome.google.com/webstore/detail/gofullpage-full-page-scre/fdpohaocaechififmbbbbbknoalclacl?hl=en) ~ A chrome extension taht allows you take full page screenshot of your current browser window. +- [Carbon](https://carbon.now.sh/) ~ Carbon is the easiest way to create and share beautiful images of your source code. +- [Isitwp](https://www.isitwp.com/headline-analyzer) ~ IsItWP Headline Analyzer tool helps you write headlines that drive traffic, shares and rank better in search results. +- [Capitalize my title](https://capitalizemytitle.com/) ~ Making title capitalization easy for your writing +- [Wordtune](https://www.wordtune.com/) ~ Wordtune turns text into concise, engaging, well-written messages. +- [Headline Analyzer](https://coschedule.com/headline-analyzer) ~ Write Headlines That Drive Traffic, Shares, And Search Results. +- [Title Generator](https://tweakyourbiz.com/title-generator) ~ Generate great titles for articles and blog posts. +- [SEO writing assistant](https://www.semrush.com/swa/) ~ A smart writing editor that helps you optimize your copy for engagement and SEO. +- [HackMD](https://hackmd.io/) ~ A collaborative markdown editor for sharing your articles and getting feedback from others. +- [Copyscape](https://www.copyscape.com/) ~ Plagiarism checker +- [MarkDoc](https://markdoc.io/) ~ A superset of Markdown for creating custom documentation websites. It was created by Stripe and made open source in May 2022. + +## Who pays technical writers + +Writing technical contents for organizations and publications is an excellent way to earn extra income. This way, you learn a lot, then share your knowledge and get paid. Check out these compiled list for organizations that pays technical writers. + +- [Community writer program](https://github.com/malgamves/CommunityWriterPrograms) +- [Get Paid to Write for These 45+ Websites](https://blog.idrisolubisi.com/get-paid-to-write-for-these-45-websites) +- [Publications That Pay You To Write Technical Articles](https://catalins.tech/websites-that-pay-you-to-write-technical-articles) + +## Open Source Projects + +Contributing to open source can be a rewarding way to learn, teach, and build experience in just about any skill you can imagine. A lot of peole contribute to open source for different reasons and the vital one which is improving one's skillset. + +Here are some articles to help you understand how to contribute to open source projects. + +- [The Technical Writers Guide to Contributing to Open Source Projects](https://edidiongasikpo.com/the-technical-writers-guide-to-contributing-to-open-source-projects) +- [How to Contribute to Open-Source as a Technical Writer](https://javascript.plainenglish.io/how-to-contribute-to-open-source-as-a-technical-writer-bb708245480c) +- [4 tips to becoming a technical writer with open source contributions](https://opensource.com/article/21/11/technical-writing-open-source) +- [Getting started with Open Source as a Technical Writer](https://amara.hashnode.dev/getting-started-with-open-source-as-a-technical-writer) + +#### Open Source Projects/Programs Technical Writers Can Contribute To + +- [Codecademy Docs](https://www.codecademy.com/resources/docs) ~ Docs is a community-driven collection of code documentation for popular programming languages and frameworks. +- [The Good Docs Project](https://thegooddocsproject.dev/) ~ The Good Docs Project is a community working together to create the templates, tools, and resources to improve the overall quality of documentation in OSS and beyond. +- [Google Season of Docs](https://developers.google.com/season-of-docs) ~ Season of Docs provides support for open source projects to improve their documentation and gives professional technical writers an opportunity to gain experience in open source. +- [Hacktoberfest](https://hacktoberfest.digitalocean.com/) ~ Hacktoberfest is a yearly event to encourage people to contribute to open source in October. +- [The GNOME Documentation Project](https://wiki.gnome.org/DocumentationProject) + +## Blogs to follow for awesome writing contents + +| Technical Writers | Blogs | Twitter Handle | +| :---------------- | ------------------------------------------ | ------------------------------------------------------- | +| Damilola Ezekiel | https://dharmelolar.hashnode.dev | [@that_yhemmygirl](https://twitter.com/that_yhemmygirl) | +| Tom Johnson | https://idratherbewriting.com/ | [@tomjohnson](https://twitter.com/tomjohnson) | +| Kesi Parker | https://medium.com/@kesiparker | [@ParkerKesi](https://twitter.com/ParkerKesi) | +| Tania Rascia | https://tania.dev/ | [@taniarascia](https://twitter.com/taniarascia) | +| Dillion Megida | https://writing.dillionmegida.com/ | [@iamdillion](https://twitter.com/iamdillion) | +| Linda Ikechukwu | https://www.everythingtechnicalwriting.com | [\_MsLinda](https://twitter.com/_MsLinda) | +| Amruta Ranade | https://dev.to/amrutaranade | [@AmrutaRanade](https://twitter.com/AmrutaRanade) | + +## Preparing for technical writing interviews + +There are several tips that can help you land an interview but some of the important ones are having a well tailored resume and cover letters. Check out these cover letter templates and tips to help you land your next interview: + +- [Cover Letter Template for your next job ](https://dillionmegida.com/p/cover-letter-template/) +- [How to Write an Enticing Cover Letter](https://ruthikegah.xyz/how-to-write-an-enticing-cover-letter) +- [How to Write a Technical Writer Resume [+Examples]](https://technicalwriterhq.com/technical-writer-resume/) +- [Best Technical Writer Cover Letter Example and Format ](https://technicalwriterhq.com/technical-writer-cover-letter/) + +Here are some resources to technical writing interview questions to help you prepare for your next interview. + +- [12 Technical Writer Interview Questions and Answers](https://technicalwriterhq.com/technical-writer-interview-questions/) +- [Google Technical Writer Interview Questions](https://technicalwriterhq.com/google-technical-writer-interview-questions/) +- [Technical Writing Job Interview](https://www.youtube.com/watch?v=cqaEgMv2JAg) + +## Sites to publish articles + +- [Hashnode](https://hashnode.com/) ~ Hashnode is a free developer blogging platform to help you share your ideas with people in tech, developers, and engineers. +- [Medium](https://medium.com/) ~ Medium is a social publishing platform with lots of users and you can publish diverse contents and ideas. +- [Dev.to](https://dev.to/) ~ Dev.to is where programmers share ideas and help each other grow. It is an online community for sharing and discovering great ideas. +- [Mirror.xyz](https://mirror.xyz/) ~ Mirror.xyz is a publishing platform for writers that leverages cryptocurrency and blockchain technology. +- [Freecodecamp](https://www.freecodecamp.org/news/how-to-write-for-freecodecamp/) ~ FreeCodeCamp is a non-profit organization that consists of an interactive learning web platform, an online community forum, chat rooms, online publications and local organizations that intend to make learning web development accessible to anyone. + +## Job Boards For Technical Writing roles + +- [Startup.jobs](https://startup.jobs/?q=Technical+writer&remote=true&utm_campaign=Everything+Technical+Writing+Newsletter&utm_medium=email&utm_source=Revue+newsletter) +- [Angel.co](https://angel.co/jobs) +- [Content Writing Jobs](https://contentwritingjobs.com/) + +## + +

Made with ❤️ by Damilola Ezekiel

From 4677f367e90e89bd3512c2e1837ce87254b7f845 Mon Sep 17 00:00:00 2001 From: Dharmelolar Date: Sat, 11 Jun 2022 19:15:46 +0100 Subject: [PATCH 05/20] add new tool --- README.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 791af9c..f8ad483 100644 --- a/README.md +++ b/README.md @@ -10,20 +10,22 @@ ## Outline +- [What is Technical Writing?](#what-is-technical-writing) +- [Outline](#outline) - [Resources](#resources) - - [Books](#books) - - [Articles](#articles) - - [Courses](#Courses) - - [Youtube](#Youtube) +- [Articles](#articles) +- [Books](#books) +- [Courses](#courses) +- [Youtube](#youtube) - [Communities](#communities) - [Tools](#tools) -- [Who pays technical writers](#Who-pays-technical-writers) -- [Open source projects](#open-source-projects) -- [Awesome technical writers](#Awesome-technical-writers) -- [Blogs to follow for awesome writing contents](#Blogs-to-follow-for-awesome-writing-contents) -- [Preparing for technical writing interviews](#Preparing-for-technical-writing-interviews) -- [Sites to publish articles](#sites-to-publish-your-articles) -- [Job boards for technical writing roles](#Job-boards-for-technical-writing-roles) +- [Who pays technical writers](#who-pays-technical-writers) +- [Open Source Projects](#open-source-projects) + - [Open Source Projects/Programs Technical Writers Can Contribute To](#open-source-projectsprograms-technical-writers-can-contribute-to) +- [Blogs to follow for awesome writing contents](#blogs-to-follow-for-awesome-writing-contents) +- [Preparing for technical writing interviews](#preparing-for-technical-writing-interviews) +- [Sites to publish articles](#sites-to-publish-articles) +- [Job Boards For Technical Writing roles](#job-boards-for-technical-writing-roles) ## Resources @@ -113,6 +115,8 @@ Communities can provide valuable learning opportunities, growth, mentorship and - [HackMD](https://hackmd.io/) ~ A collaborative markdown editor for sharing your articles and getting feedback from others. - [Copyscape](https://www.copyscape.com/) ~ Plagiarism checker - [MarkDoc](https://markdoc.io/) ~ A superset of Markdown for creating custom documentation websites. It was created by Stripe and made open source in May 2022. +- [Wordtune](https://www.wordtune.com/) ~ Wordtune is an AI- powered writing companion that rephrases your sentences to say exactly what you mean through clear, compelling, and authentic writing. + ## Who pays technical writers From a0d2511953cb55cb28c340fa3644c33ec10c2f6a Mon Sep 17 00:00:00 2001 From: Daniel Idowu <74189249+dharniel45@users.noreply.github.com> Date: Sat, 17 Sep 2022 17:35:50 +0100 Subject: [PATCH 06/20] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f8ad483..3bb7c69 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,7 @@ Communities can provide valuable learning opportunities, growth, mentorship and - [The Good Docs Project Community](https://thegooddocsproject.dev/community/) - [Techwriters.dev](https://techwriters.dev/) - [r/technicalwriting](https://www.reddit.com/r/technicalwriting/) +- [Inked-in](https://geller99.medium.com/inked-in-what-is-it-and-why-is-everyone-talking-about-it-daba7c0a8b15) ## Tools @@ -116,7 +117,8 @@ Communities can provide valuable learning opportunities, growth, mentorship and - [Copyscape](https://www.copyscape.com/) ~ Plagiarism checker - [MarkDoc](https://markdoc.io/) ~ A superset of Markdown for creating custom documentation websites. It was created by Stripe and made open source in May 2022. - [Wordtune](https://www.wordtune.com/) ~ Wordtune is an AI- powered writing companion that rephrases your sentences to say exactly what you mean through clear, compelling, and authentic writing. - +- [Power Thesaurus](https://www.powerthesaurus.org/) ~ Power Thesaurus is an online thesaurus for writers that is free, fast, comprehensive, and simple to use. It can help you find synonyms and acronyms. +- [Lose the Very](https://www.losethevery.com/) ~ A tool that helps youu replace words like "Very Good". ## Who pays technical writers @@ -185,6 +187,7 @@ Here are some resources to technical writing interview questions to help you pre - [Startup.jobs](https://startup.jobs/?q=Technical+writer&remote=true&utm_campaign=Everything+Technical+Writing+Newsletter&utm_medium=email&utm_source=Revue+newsletter) - [Angel.co](https://angel.co/jobs) - [Content Writing Jobs](https://contentwritingjobs.com/) +- [Write the Docs Job Board](https://jobs.writethedocs.org/) ## From c6f88989ed96fa1bfbc6ecca38797d4a61fd41ec Mon Sep 17 00:00:00 2001 From: Daniel Idowu <74189249+dharniel45@users.noreply.github.com> Date: Sat, 17 Sep 2022 17:36:40 +0100 Subject: [PATCH 07/20] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3bb7c69..df5cc67 100644 --- a/README.md +++ b/README.md @@ -118,7 +118,7 @@ Communities can provide valuable learning opportunities, growth, mentorship and - [MarkDoc](https://markdoc.io/) ~ A superset of Markdown for creating custom documentation websites. It was created by Stripe and made open source in May 2022. - [Wordtune](https://www.wordtune.com/) ~ Wordtune is an AI- powered writing companion that rephrases your sentences to say exactly what you mean through clear, compelling, and authentic writing. - [Power Thesaurus](https://www.powerthesaurus.org/) ~ Power Thesaurus is an online thesaurus for writers that is free, fast, comprehensive, and simple to use. It can help you find synonyms and acronyms. -- [Lose the Very](https://www.losethevery.com/) ~ A tool that helps youu replace words like "Very Good". +- [Lose the Very](https://www.losethevery.com/) ~ A tool that helps you replace words like "Very Good". ## Who pays technical writers From ffd063117eebf2634dedbd33b0eda383a4612648 Mon Sep 17 00:00:00 2001 From: sanvi0071 Date: Sun, 2 Oct 2022 12:29:12 +0530 Subject: [PATCH 08/20] add text copyright in README --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index df5cc67..9c7cae7 100644 --- a/README.md +++ b/README.md @@ -190,5 +190,7 @@ Here are some resources to technical writing interview questions to help you pre - [Write the Docs Job Board](https://jobs.writethedocs.org/) ## - + \ No newline at end of file From ca69136993fc4efb454253a89e67fa6d729adc03 Mon Sep 17 00:00:00 2001 From: Nilesh Date: Sun, 2 Oct 2022 13:17:17 +0530 Subject: [PATCH 09/20] 7 types added --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index df5cc67..5ab64ed 100644 --- a/README.md +++ b/README.md @@ -182,6 +182,18 @@ Here are some resources to technical writing interview questions to help you pre - [Mirror.xyz](https://mirror.xyz/) ~ Mirror.xyz is a publishing platform for writers that leverages cryptocurrency and blockchain technology. - [Freecodecamp](https://www.freecodecamp.org/news/how-to-write-for-freecodecamp/) ~ FreeCodeCamp is a non-profit organization that consists of an interactive learning web platform, an online community forum, chat rooms, online publications and local organizations that intend to make learning web development accessible to anyone. +## 7 Types of Technical-writing +- instruction manuals +- proposals +- reports +- posters and visual communication +- technical descriptions +- product recalls +- white papers + + + + ## Job Boards For Technical Writing roles - [Startup.jobs](https://startup.jobs/?q=Technical+writer&remote=true&utm_campaign=Everything+Technical+Writing+Newsletter&utm_medium=email&utm_source=Revue+newsletter) From 1287b807432270f1a62ed2226e7dcd8cc7aa2479 Mon Sep 17 00:00:00 2001 From: amrit Date: Sun, 2 Oct 2022 13:40:58 +0530 Subject: [PATCH 10/20] docs: update contributing.md --- CONTRIBUTING.md | 52 ++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 43 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c12831e..6bbae2e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,8 @@ -🎉🥳Yayyyy!!!! Thanks for taking time to contribute to this open source project. +# Contributing Guidelines -Inorder to contribute to this project, there are some guidelines to be followed and you can make a pull request to make additional changes. +🎉🥳Yayyyy!!!! Thanks for taking time to contribute to this open source project. +[Technical Writing Resources](https://github.com/dharmelolar/technical-writing-resources) is [MIT license](https://github.com/dharmelolar/technical-writing-resources/blob/main/LICENSE.md) licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on development workflow, commit message formatting, contact points, and other resources to make it easier to get your contribution accepted. ## How do I make contributions @@ -12,6 +13,14 @@ All forms of contributions are welcomed. Here are some ways to get started with - Add new suggestions to the outline - Add links to resources . +## Getting Started + +- Fork the repository on GitHub. +- Clone the forked repository, onto your local system: + - [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop. + - Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)! +- Create a working branch and start with your changes! + ## Guidelines for contributing - Pull requests should be descriptive @@ -19,14 +28,39 @@ All forms of contributions are welcomed. Here are some ways to get started with - Use desriptive commit messages. - If you're suggesting a very big change, kindly open an issue first. -## How do I submit a Pull Request (PR)? -Contributing follows this workflow: +## Contribution Flow + +This is a outline of what a contributor's workflow looks like: + +- Create a separate branch from `master` branch to base your work. +- Make commits of logical units. +- Make sure your commit messages are in the standard format (see below). +- Push your changes to a topic branch in your fork of the repository. +- Make sure to proofread the content before submitting. +- Fetch Upstream & make sure your fork / branch is conflict free +- Submit a pull request to the original repository. + +#### Commit Messages + +Please follow the below format while writing commit messages: + +``` + title: One line description about your change + + description: An optional description of your changes +``` + +## Pull Request + +When you're finished with the changes, create a pull request, also known as a PR. + +- Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request for additional information. +- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch. +- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). +- If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues. + +Thanks for your contributions! -- Fork this project repository. -- Clone the forked repository to your computer. -- Create and switch into a new branch. -- Edit or create an entry and commit the changes. -- Make a PR to merge your fork with this repo.
From acc0f2ead2c564929a535c3bd4ef49fa69b0ca43 Mon Sep 17 00:00:00 2001 From: URRG <95937956+URRG@users.noreply.github.com> Date: Sun, 2 Oct 2022 23:19:33 +0530 Subject: [PATCH 11/20] README.md --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9c7cae7..6cfbe0a 100644 --- a/README.md +++ b/README.md @@ -119,6 +119,15 @@ Communities can provide valuable learning opportunities, growth, mentorship and - [Wordtune](https://www.wordtune.com/) ~ Wordtune is an AI- powered writing companion that rephrases your sentences to say exactly what you mean through clear, compelling, and authentic writing. - [Power Thesaurus](https://www.powerthesaurus.org/) ~ Power Thesaurus is an online thesaurus for writers that is free, fast, comprehensive, and simple to use. It can help you find synonyms and acronyms. - [Lose the Very](https://www.losethevery.com/) ~ A tool that helps you replace words like "Very Good". +- [Blackbox](https://www.useblackbox.io/landingPage) ~ It is the fastest way to copy text from videos, images, PDFs, anything. +- [Overleaf](https://www.overleaf.com/) ~ An online LaTeX editor that's easy to use an mainly used to make CV. +- [Linktree](https://linktr.ee/) ~ It is a tool that allows you to share multiple links. +- [Slidesgo](https://slidesgo.com/) ~ Helps in finding some crazy PPT templates. +- [Wallpaper haven](https://wallhaven.cc/) ~ High resolution wallpapers. +- [Flaticon](https://www.flaticon.com/) ~ High quality stickers and icons for free. +- [Magic Eraser](https://www.magiceraser.io/) ~ Removes any unwanted item from your image. +- [Jenni Ai](https://jenni.ai/) ~ An AI auto-writing tool that automatically writes your essays and emails for you. +- [Flowcode](https://www.flowcode.com/codes) ~ Create Dynamic QR Code for free with no restrictions. ## Who pays technical writers @@ -193,4 +202,4 @@ Here are some resources to technical writing interview questions to help you pre \ No newline at end of file + From 41d83e2805b8561db7aa71d31f268a0ffd3aa5e7 Mon Sep 17 00:00:00 2001 From: Amrit Anand Date: Sun, 2 Oct 2022 23:35:19 +0530 Subject: [PATCH 12/20] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6bbae2e..1938502 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,7 @@ All forms of contributions are welcomed. Here are some ways to get started with ## Getting Started - Fork the repository on GitHub. -- Clone the forked repository, onto your local system: +- Clone the forked repository, into your local system: - [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop. - Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)! - Create a working branch and start with your changes! @@ -64,4 +64,4 @@ Thanks for your contributions!
-

Made with ❤️ by Damilola Ezekiel

\ No newline at end of file +

Made with ❤️ by Damilola Ezekiel

From 88492f0268ae3370ead8cbcff99c944d7d51eb12 Mon Sep 17 00:00:00 2001 From: Nilesh Ramesh Lad <89249015+nileshlad09@users.noreply.github.com> Date: Mon, 3 Oct 2022 09:17:28 +0530 Subject: [PATCH 13/20] Update README.md Done --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5ab64ed..d67a2ea 100644 --- a/README.md +++ b/README.md @@ -182,14 +182,14 @@ Here are some resources to technical writing interview questions to help you pre - [Mirror.xyz](https://mirror.xyz/) ~ Mirror.xyz is a publishing platform for writers that leverages cryptocurrency and blockchain technology. - [Freecodecamp](https://www.freecodecamp.org/news/how-to-write-for-freecodecamp/) ~ FreeCodeCamp is a non-profit organization that consists of an interactive learning web platform, an online community forum, chat rooms, online publications and local organizations that intend to make learning web development accessible to anyone. -## 7 Types of Technical-writing -- instruction manuals -- proposals -- reports -- posters and visual communication -- technical descriptions -- product recalls -- white papers +## Types of Technical-writing +- Instruction manuals +- Proposals +- Reports +- Posters and Visual Communication +- Technical Descriptions +- Product Recalls +- White Papers From beb4c19b890b0fb04ed1a135007b7b610e6778bb Mon Sep 17 00:00:00 2001 From: Ashish Abraham <83216788+Ashish-Abraham@users.noreply.github.com> Date: Mon, 3 Oct 2022 23:40:35 +0530 Subject: [PATCH 14/20] Added Unsplash to tools Unsplash is a free and safe source to find great images for your content without copyright issues. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9c7cae7..07f431b 100644 --- a/README.md +++ b/README.md @@ -119,6 +119,7 @@ Communities can provide valuable learning opportunities, growth, mentorship and - [Wordtune](https://www.wordtune.com/) ~ Wordtune is an AI- powered writing companion that rephrases your sentences to say exactly what you mean through clear, compelling, and authentic writing. - [Power Thesaurus](https://www.powerthesaurus.org/) ~ Power Thesaurus is an online thesaurus for writers that is free, fast, comprehensive, and simple to use. It can help you find synonyms and acronyms. - [Lose the Very](https://www.losethevery.com/) ~ A tool that helps you replace words like "Very Good". +- [Unsplash](https://unsplash.com/) ~ A free and safe image source for your content, without running into copyright issues. ## Who pays technical writers @@ -193,4 +194,4 @@ Here are some resources to technical writing interview questions to help you pre \ No newline at end of file + From 4379118f9ea8df0d4eb76463db076c2b9a1c064f Mon Sep 17 00:00:00 2001 From: Ashish Abraham <83216788+Ashish-Abraham@users.noreply.github.com> Date: Mon, 3 Oct 2022 23:46:01 +0530 Subject: [PATCH 15/20] Added How to Avoid Plagiarism in Articles Keeping a check on plagiarism is an essential part of technical writing as we refer to many resources while creating content. Added article on how to avoid plagiarism. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 07f431b..fa05451 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,7 @@ This repository contains different technical writing resources that has been gat - [Writing Tips for Software Developers – How to Become a Better Tech Writer](https://www.freecodecamp.org/news/writing-tips-software-developers/) - [11 Best Practices for Writing API Documentation](https://treblle.com/blog/11-best-practices-for-writing-api-documentation) - [Technical Writing vs Technical Blogging](https://lo-victoria.com/what-you-need-to-know-about-technical-writing-vs-technical-blogging#cknj3ppa30d7m2ks14c8o0vnf) +- [How to avoid Plagiarism in Technical Writing](https://www.grammarly.com/blog/5-most-effective-methods-for-avoiding-plagiarism/) ## Books From 77ef191a81a803b831692ca74c7004aa5fa3b240 Mon Sep 17 00:00:00 2001 From: Nakam <89482825+Nakamcode@users.noreply.github.com> Date: Tue, 4 Oct 2022 00:49:03 +0000 Subject: [PATCH 16/20] feat: added scrolluplink --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index bbd4ea6..bf5fe1f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +
@@ -27,6 +28,8 @@ - [Sites to publish articles](#sites-to-publish-articles) - [Job Boards For Technical Writing roles](#job-boards-for-technical-writing-roles) +

(back to top)

+ ## Resources This repository contains different technical writing resources that has been gathered from all around the internet @@ -47,6 +50,8 @@ This repository contains different technical writing resources that has been gat - [Technical Writing vs Technical Blogging](https://lo-victoria.com/what-you-need-to-know-about-technical-writing-vs-technical-blogging#cknj3ppa30d7m2ks14c8o0vnf) - [How to avoid Plagiarism in Technical Writing](https://www.grammarly.com/blog/5-most-effective-methods-for-avoiding-plagiarism/) +

(back to top)

+ ## Books - [Writing Well](https://www.julian.com/guide/write/intro) ~ Julian Shapiro @@ -60,6 +65,8 @@ This repository contains different technical writing resources that has been gat - [On Writing Well](https://www.amazon.com/gp/product/0060891548/ref=as_li_tl?ie=UTF8&tag=techlife09-20&camp=1789&creative=9325&linkCode=as2&creativeASIN=0060891548&linkId=27bd72a8da3fb242b39dbe4edb470daf) ~ William Zinsser - [Technical Communication](https://www.amazon.com/Technical-Communication-Mike-Markel-dp-1319245005/dp/1319245005/ref=dp_ob_image_bk) ~ Mike Markel +

(back to top)

+ ## Courses - [Technical Writing Courses for Engineers](https://developers.google.com/tech-writing) @@ -71,6 +78,8 @@ This repository contains different technical writing resources that has been gat - [SEO FOR DEVS](https://seofordevs.com/) ~ SEO FOR DEVS is a free 2 weeks course that helps people discover your tech blog or side project in a systematic way - [API Documentation for Developers](https://apidocsfordevs.com/) ~ A hands-on guide to creating and maintaining API documentation. +

(back to top)

+ ## Youtube - [DocToHelpTV](https://www.youtube.com/user/DocToHelpTV/videos) @@ -79,6 +88,8 @@ This repository contains different technical writing resources that has been gat - [William Smith](https://www.youtube.com/watch?v=amKDhaIlyOc) - [How to become a Technical Writer | Skills & Career Growth](youtube.com/watch?v=8l2KJXIBpB0) +

(back to top)

+ ## Communities Communities can provide valuable learning opportunities, growth, mentorship and career advancement. Connecting with people of similar interest is one of the reasons why people join communities. Here are some of the communities that technical writers can join: @@ -94,6 +105,8 @@ Communities can provide valuable learning opportunities, growth, mentorship and - [r/technicalwriting](https://www.reddit.com/r/technicalwriting/) - [Inked-in](https://geller99.medium.com/inked-in-what-is-it-and-why-is-everyone-talking-about-it-daba7c0a8b15) +

(back to top)

+ ## Tools - [Canva](https://www.canva.com/) ~ Canva is a graphic design platform, used to create social media graphics, presentations, posters, documents and other visual content. @@ -132,6 +145,8 @@ Communities can provide valuable learning opportunities, growth, mentorship and - [Jenni Ai](https://jenni.ai/) ~ An AI auto-writing tool that automatically writes your essays and emails for you. - [Flowcode](https://www.flowcode.com/codes) ~ Create Dynamic QR Code for free with no restrictions. +

(back to top)

+ ## Who pays technical writers Writing technical contents for organizations and publications is an excellent way to earn extra income. This way, you learn a lot, then share your knowledge and get paid. Check out these compiled list for organizations that pays technical writers. @@ -140,6 +155,8 @@ Writing technical contents for organizations and publications is an excellent wa - [Get Paid to Write for These 45+ Websites](https://blog.idrisolubisi.com/get-paid-to-write-for-these-45-websites) - [Publications That Pay You To Write Technical Articles](https://catalins.tech/websites-that-pay-you-to-write-technical-articles) +

(back to top)

+ ## Open Source Projects Contributing to open source can be a rewarding way to learn, teach, and build experience in just about any skill you can imagine. A lot of peole contribute to open source for different reasons and the vital one which is improving one's skillset. @@ -151,6 +168,8 @@ Here are some articles to help you understand how to contribute to open source p - [4 tips to becoming a technical writer with open source contributions](https://opensource.com/article/21/11/technical-writing-open-source) - [Getting started with Open Source as a Technical Writer](https://amara.hashnode.dev/getting-started-with-open-source-as-a-technical-writer) +

(back to top)

+ #### Open Source Projects/Programs Technical Writers Can Contribute To - [Codecademy Docs](https://www.codecademy.com/resources/docs) ~ Docs is a community-driven collection of code documentation for popular programming languages and frameworks. @@ -159,6 +178,8 @@ Here are some articles to help you understand how to contribute to open source p - [Hacktoberfest](https://hacktoberfest.digitalocean.com/) ~ Hacktoberfest is a yearly event to encourage people to contribute to open source in October. - [The GNOME Documentation Project](https://wiki.gnome.org/DocumentationProject) +

(back to top)

+ ## Blogs to follow for awesome writing contents | Technical Writers | Blogs | Twitter Handle | @@ -171,6 +192,8 @@ Here are some articles to help you understand how to contribute to open source p | Linda Ikechukwu | https://www.everythingtechnicalwriting.com | [\_MsLinda](https://twitter.com/_MsLinda) | | Amruta Ranade | https://dev.to/amrutaranade | [@AmrutaRanade](https://twitter.com/AmrutaRanade) | +

(back to top)

+ ## Preparing for technical writing interviews There are several tips that can help you land an interview but some of the important ones are having a well tailored resume and cover letters. Check out these cover letter templates and tips to help you land your next interview: @@ -186,6 +209,8 @@ Here are some resources to technical writing interview questions to help you pre - [Google Technical Writer Interview Questions](https://technicalwriterhq.com/google-technical-writer-interview-questions/) - [Technical Writing Job Interview](https://www.youtube.com/watch?v=cqaEgMv2JAg) +

(back to top)

+ ## Sites to publish articles - [Hashnode](https://hashnode.com/) ~ Hashnode is a free developer blogging platform to help you share your ideas with people in tech, developers, and engineers. @@ -194,6 +219,8 @@ Here are some resources to technical writing interview questions to help you pre - [Mirror.xyz](https://mirror.xyz/) ~ Mirror.xyz is a publishing platform for writers that leverages cryptocurrency and blockchain technology. - [Freecodecamp](https://www.freecodecamp.org/news/how-to-write-for-freecodecamp/) ~ FreeCodeCamp is a non-profit organization that consists of an interactive learning web platform, an online community forum, chat rooms, online publications and local organizations that intend to make learning web development accessible to anyone. +

(back to top)

+ ## Types of Technical-writing - Instruction manuals - Proposals @@ -204,6 +231,7 @@ Here are some resources to technical writing interview questions to help you pre - White Papers +

(back to top)

## Job Boards For Technical Writing roles @@ -213,6 +241,8 @@ Here are some resources to technical writing interview questions to help you pre - [Content Writing Jobs](https://contentwritingjobs.com/) - [Write the Docs Job Board](https://jobs.writethedocs.org/) +

(back to top)

+ ##