bennykillua / getting-started-in-technical-writing

A compilation of useful resources for anyone who wants to get started in technical writing.

Hi there 👋

I'm Benny Ifeanyi Iheagwara... I am a educator, data analyst, technical writer and content creator 🚀

Passionate about anything data, ML, and DevOps best practices.

💬 Ask me about OSS, machine learning, and data analysis

👐 Contributed to GeeksforGeeks, Ansible, docToolchain, and BastilleBSD.

📙 Currently contributing to NumPy.

Also check out this technical writing resource repo.

I took part in Hacktoberfest 2022! Here are some badges and a tree planted in my name. Here is the Tree Planting Certificate

Languages: Python and DAX.

• 👯 I’m looking to collaborate on documentations, open source projects, and data science and machine learning related projects.

Hashnode Blog Posts.

• Building a Question Answering Search Engine with Power Query, OpenAI, MindsDB, Streamlit,and MindsDB SDK using SQL
• All The Damn Things - The Complete Non Code Contributor List
• Sharing Accounts Through Cookies
• Analyze Blockchain and DeFi data in minutes with SQL and Dune Analytics: A Quickstart Guide
• On-premise vs. Cloud: Should you make the shift?

📝 Writing ✍️

• Data Visualization with Chartify
• How to Contribute to Open Source Projects as a Non-Coder?
• Feedbakly: How to give and receiving feedback
• HDSC Stage F OSP- Weather Forecasting: A time series analysis.
• Covid-19 Project: Case study Nigeria 😷

Connect with me:

Support:

getting-started-in-technical-writing's Issues

Add YouTube Video link

Post Video recording and add to this file

What is a style guide?

Please provide a brief definition of a style guide in two lines.

File

Add Technical writing resource

Do you know any Technical writing resource?

Getting started article perhaps

Style Guide

Add what you find here

Adding more examples of markdown syntax

The markdown file needs more syntax added to it.

Here is a link to the file.

Add publication on can contribute to

Add publication on can contribute to:

• Medium publication
• Free code camp
• Open source . com
• Microsoft 365 community Blog (https://pnp.github.io/blog/)

Add resource here

You can also keep a link or two of how

Technical Writing courses

Do you know any other technical writing courses?

Add what you find here

Please it would be best if you have perhaps taken the course before. Not random courses.

Add a guide for Hacktoberfest

Add the article here

Move md files of learning path

Move md files of learning path to this folder to uncloug the repo.

This will leads to broken link which should also be resolved.

Creating something visual that can be embedded on the repo.

I thought we could have visual emlement on the repo. Something like the GitHub Octodex

Add New Tutor Video

I will like to add a couple of videos from the Technical Writing Mentorship YT channel

broken airbyte docs link

the link https://docs.airbyte.com/contributing-to-airbyte/updating-documentation/ in contributing in open source as a technical writer is broken

Add Open source guide for technical writer

How can one contribute as a technical writer ?

How can they find repo?

Resource

• https://benny.hashnode.dev/how-to-contribute-to-open-source-projects-as-a-non-coder
• https://opensource.com/article/21/11/technical-writing-open-source
• https://medium.com/technical-writing-is-easy/open-source-projects-for-technical-writers-de53fb3dd4c9
• https://edidiongasikpo.com/the-technical-writers-guide-to-contributing-to-open-source-projects

Add resource here Thank you