Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Technical Writing Resources Category #981

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
155 changes: 155 additions & 0 deletions Technical Writing/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
# Technical Writing

Technical writing is a type of writing that focuses on delivering clear, concise, and structured information about complex and specialized subjects. It is used in various fields such as science, engineering, technology, and business to communicate technical information in a way that is easily understood by the intended audience.

Technical writing is more than just putting words on paper; it's about making complex ideas accessible. Imagine trying to assemble a new piece of furniture without clear instructions, or navigating advanced software without a user manual. Frustrating, right? Technical writers bridge the gap between complexity and comprehension, ensuring that users, clients, and colleagues can easily understand and utilize sophisticated products and processes.

## Table of Contents

- [Roadmap](#roadmap)
- [Skills-Required](#skills-required)
- [Platform-for-Publishing-Article](#platforms-to-publish-your-articles)
- [Forums-and-Communitites](#forums-and-communities)
- [Courses](#technical-writing-courses)
- [Youtube Tutorials and Blogs](#youtube-channels-and-blogs)
- [Make Money As A Technical Writer](#make-money-as-a-technical-writer)
- [Amazing-Technical-Writers](#amazing-technical-writers)
- [Conclusion](#conclusion)


### Roadmap

>Embark on a transformative journey to refine your technical writing skills with this essential guide. Whether you're new to the field or looking to elevate your expertise, discover strategies and resources to make complex ideas clear and accessible. This roadmap will illuminate your path to excellence.

<table width="100%" id="roadmap">
<tr>
<th>Resource Name</th>
<th>Description</th>
</tr>
<tr>
<td><a href="https://roadmap.sh/technical-writer">Complete Roadmap To Become Technical Writer From Scratch</a></td>
<td>Here in this roadmap, there is comprehensive guide from novice to expert with this all-encompassing guide designed for absolute beginners.</td>
</tr>
</table>

### Skills Required

>There are essential skills you need to cultivate in order to excel in the field of technical writing.

<table width="100%" id="skills">
<tr>
<th>Skills</th>
<th>Description</th>
</tr>
<tr>
<td><a href="https://whatfix.com/blog/technical-writing-skills/#:~:text=Technical%20writers%20need%20to%20have,that%20holds%20up%20under%20scrutiny.">Technical Expertise</a></td>
<td>Tech expertise in technical writing involves understanding complex technical processes and translating them into simple, clear language. This skill is developed through education, experience, or personal interest. It includes using software tools, conducting research, and sometimes coding, allowing technical writers to create accurate and user-friendly documents.</td>
</tr>
<tr>
<td><a href="https://corporatefinanceinstitute.com/resources/career/language-proficiency-levels/"> Language Proficiency </a></td>
<td> Language proficiency is crucial in technical writing, requiring exceptional command over the document's language. This includes grammar, semantics, syntax, and vocabulary. Technical writers must simplify complex ideas for clarity and effectiveness and be familiar with industry-specific terminology.</td>
</tr>
<tr>
<td><a href="https://www.some.education/blog/effective-written-communication-and-its-importance">Written Communication Proficiency</a></td>
<td>Written communication is vital for technical writers, encompassing clear, concise conveyance of complex information, proper content structure, consistent tone, and illustrative examples. Accuracy is critical, as technical writing involves precise descriptions of intricate processes. Adapting to different writing styles and audience comprehension levels is also essential. </td>
</tr>
</table>

### Platforms To Publish Your Articles

<table width="100%" id="platforms">
<tr>
<th>Platforms</th>
<th>Description</th>
</tr>
<tr>
<td><a href="https://dev.to/">Dev.to</a></td>
<td>It is a community of thousands of techies where both writers and readers get to meaningfully engage and share ideas and resources.</td>
</tr>
<td><a href="https://hashnode.com/">Hashnode</a></td>
<td>It is my go-to blogging platform with awesome perks such as custom domain mapping and an interactive community. Setting up a blog on this platform is also easy and fast.</td>
</tr>
<td><a href="https://www.freecodecamp.org/">freeCodeCamp</a></td>
<td>It has a very large community and audience reach and is a great place to publish your articles. However, you'll need to apply to write for their publication with some previous writing samples.</td>
</tr>
</tr>
<td><a href="https://medium.com/">Medium</a></td>
<td>Medium is a popular platform for posting content, and it offers several advantages for writers and readers alike.</td>
</tr>
</table>

### Forums and Communities

>Joining a Tech Community is the easiest way to network with and learn from other techies in the industry for free. You get to connect to other techies with different levels of expertise, network and socialize, attend tech events, ask questions and get answers from experts and professionals, share and learn from other people's experiences.

Here are a few of the most popular tech communities:

- [Write the doc](https://www.writethedocs.org/)
- [None Tech In Tech](https://x.com/nontech_it)
- [Empower Her ommunity](https://www.linkedin.com/company/empower-her-community/?trk=ppro_cprof&originalSubdomain=in)
- [Scaler Discord Community](https://www.scaler.com/discord/)
- [Technical Writing Forum](https://www.linkedin.com/groups/112571/)


### Technical Writing Courses

>Enrolling in a technical writing course offers a comprehensive roadmap, guiding you through every aspect of the craft while significantly boosting your confidence to embark on this transformative writing journey.

- [Google Technical Writing Course ](https://developers.google.com/tech-writing)(Free)
- [Udemy Technical Writing Course ](https://www.udemy.com/topic/technical-writing/)(Paid)
- [Hashnode Technical Writing Bootcamp](https://hashnode.com/bootcamp/batch-2) (Free)

### Youtube Channels And Blogs

>Enhance your skills and stay updated with industry trends by diving into these top YouTube channels and blogs. These resources offer invaluable insights, tips, and tutorials to help you excel in the field of technical writing.

- [Amruta Ranade](https://www.youtube.com/watch?v=JHm3kVMITmI&t=536s)
- [TALL TALKS FROM A SHORT LADY !](https://www.youtube.com/@talltalksfromashortlady2798)
- [A Beginners-Guide For Technical Writing (Roadmap)](https://bobbay.hashnode.dev/a-beginners-guide-for-technical-writing-roadmap)
- [Technical Writer HQ](https://www.youtube.com/@technicalcommunication)
- [Technical Writing for Beginners](https://www.freecodecamp.org/news/technical-writing-for-beginners/)
- [Begin Your Technical Writing Journey!](https://roadmaps.timonwa.com/careers/technicalwriting)
- [Get Started as a Technical Writer in 30 Days](https://www.youtube.com/watch?v=3G759p2X49Q)
- [Top 10 Tips for Great Technical Writing](https://document360.com/blog/top-10-tips-for-great-technical-writing/)


### Make Money As A Technical Writer

>You can also make money as a technical writer by contributing to organizations. Here are some organizations that pay you to write for them, like:

- [Smashing Magzine](https://www.smashingmagazine.com/)
- [AuthO](https://auth0.com/)
- [Twilio](https://www.twilio.com/en-us)
- [Stack Overflow](https://stackoverflow.com/)

#### Internships and Mentoring

>Internships offer invaluable professional learning experiences tailored to your field of study or career aspirations. During an internship, you’ll have the opportunity to work under the guidance of experienced mentors and industry experts, often collaborating on real-world projects. These internships can be either paid or unpaid, with some programs providing financial compensation upon successful completion. Below, you'll find a list of organizations that offer coding internships and mentorship opportunities in the field of technical writing.

- [Outreachy](https://www.outreachy.org/) (paid)
- [Google Season of Docs (GSOD)](https://developers.google.com/season-of-docs) (paid)

### Amazing technical Writers

>In the realm of technical writing, many remarkable writers have embarked on inspiring journeys, demonstrating consistency and unique styles. These individuals are often regarded as virtual mentors, offering invaluable guidance through their work.
><p>Occasionally, they share technical writing tips that prove to be incredibly helpful, contributing significantly to the growth and learning of aspiring writers.<p>
Here are some of those esteemed writers:

- [Quincy Larson](https://x.com/ossia)
- [Edidiong Asikpo](https://x.com/didicodes)
- [Catalin Pit](https://x.com/catalinmpit)
- [Victoria Lo](https://twitter.com/lo_victoria2666)
- [Bolaji Ayodeji](https://twitter.com/iambolajiayo)
- [Amruta Ranade](https://twitter.com/amrutaranade)
- [Chris Bongers](https://twitter.com/dailydevtips1)
- [Colby Fayock](https://twitter.com/colbyfayock)

### Conclusion

Starting a career in technical writing doesn't require a formal degree in the field. You can begin by sharing your technical content on personal blogs or contributing to public GitHub repositories. This hands-on approach helps you build a solid portfolio while gaining valuable practical experience.

One effective way to practice is by creating documentation for existing programs or projects. Explore the vast array of open-source projects available on GitHub, where you can contribute by improving and expanding their documentation. This not only hones your skills but also demonstrates your expertise and initiative to potential employers or clients.

"To get started, dive into writing right away".

****
1 change: 1 addition & 0 deletions website/about.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ <h2>Categories</h2>
<li>Programming Languages</li>
<li>Data Science</li>
<li>Machine Learning</li>
<li>Technical Writing</li>
</ul>
</div>
<div class="card">
Expand Down