├── .github └── ISSUE_TEMPLATE │ └── custom.md ├── BuyCoins API in AsciiDoc ├── README.md └── buycoin.adoc ├── CONTRIBUTING.md ├── Contribute by Forking.md ├── Contributing to open source as a technical writer.md ├── Contributing to publications as a technical writer.md ├── Contributor.md ├── Docs as Code.md ├── Empower Her X Non Tech in Tech.md ├── Interviews and getting paid.md ├── Learning Git.MD ├── Learning Markdown.md ├── Learning Resources ├── Speak.md └── Technical writing slides.md ├── Polygon ├── Polygon.adoc └── README.md ├── Productivity and everythin in between.md ├── README.md ├── Repo-Images ├── YouTube timetsamp_Making contributions via GitHub.txt ├── fork.png └── readme.md ├── SEO.md ├── Technical Writing Courses.md └── Technical Writing Resources.md /.github/ISSUE_TEMPLATE/custom.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Custom issue template 3 | about: Describe this issue template's purpose here. 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | 11 | -------------------------------------------------------------------------------- /BuyCoins API in AsciiDoc/README.md: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /BuyCoins API in AsciiDoc/buycoin.adoc: -------------------------------------------------------------------------------- 1 | :jbake-title: Buycoin Introduction 2 | :jbake-type: page_toc 3 | :jbake-status: published 4 | :jbake-menu: arc42 5 | :jbake-order: 14 6 | :filename: \chapters\Buycoin.adoc 7 | ifndef::imagesdir[:imagesdir: ../../images] 8 | 9 | :toc: 10 | 11 | [[section-introduction-and-goals]] 12 | == Introduction 13 | 14 | Welcome to the BuyCoins API 15 | 16 | === Other APIs 17 | 18 | If you're looking for documentation for our other API services: 19 | 20 | * *Sendcash API*: The Sendcash API lets you wire money to any US bank account. More countries coming soon. Here are the https://docs.sendcash.africa/[docs]. 21 | 22 | * *Sendcash Pay*: Sendcash Pay lets your users initiate instant bank payments directly within your application. Here are the https://sendcashpay.com/docs/intro[docs]. 23 | 24 | == How do I get access to Buycoins API? 25 | 26 | The API is currently open to access requests from fully verified BuyCoins users. To apply, please send an email to *support@buycoins.africa* from your email account registered on BuyCoins. 27 | 28 | == What can I do with the API? 29 | 30 | The core features of the API are: 31 | 32 | . Buy & Sell supported cryptocurrencies (Bitcoin, Ethereum, Litecoin, Tether, Naira token, BSC Naira token & U.S. Dollar Coin). 33 | 34 | . Send supported currencies to external addresses. 35 | 36 | . Generate addresses to receive supported currencies. 37 | 38 | With some combination of the above you can build a vast array of many different products or features. Here are some examples: 39 | 40 | . Accept Bitcoin payments in your app or website. 41 | 42 | . Pay users of your app/website with Bitcoin or other currencies. 43 | 44 | . You can combine the two examples above to build a remittance product. 45 | 46 | . Build an entire exchange that lets users buy, sell & store cryptocurrency. 47 | 48 | ==== 49 | Next 50 | 51 | *Tools and Libraries* 52 | ==== 53 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | 2 | # Code of Conduct and Contributing Guidelines 3 | 4 | # Contributing 5 | 6 | Welcome to the community! If you'd like to submit a contributions, please make a pull request directly and we'll review it. 7 | 8 | If you'd like to suggest a change to the data or the way it's organized here, please one up an issue. first so we can discuss it. 9 | 10 | Please note we have a code of conduct. Follow it in all your interactions with the project. 11 | 12 | ## Pull Request Process 13 | 14 | 1. Update the README.md 15 | 2. Create the pull request and explain your changes. We'll merge it in or reply as quickly as possible. 16 | 17 | ## How to contribute 18 | 19 | Learn how to make a [contribution](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Contribute%20by%20Forking.md) 20 | 21 | # Code of Conduct 22 | 23 | ## Our Pledge 24 | 25 | We as members, contributors, and leaders pledge to make participation in our 26 | community a harassment-free experience for everyone, regardless of age, body 27 | size, visible or invisible disability, ethnicity, sex characteristics, gender 28 | identity and expression, level of experience, education, socio-economic status, 29 | nationality, personal appearance, race, religion, or sexual identity 30 | and orientation. 31 | 32 | We pledge to act and interact in ways that contribute to an open, welcoming, 33 | diverse, inclusive, and healthy community. 34 | 35 | ## Our Standards 36 | 37 | Examples of behavior that contributes to a positive environment for our 38 | community include: 39 | 40 | * Demonstrating empathy and kindness toward other people 41 | * Being respectful of differing opinions, viewpoints, and experiences 42 | * Giving and gracefully accepting constructive feedback 43 | * Accepting responsibility and apologizing to those affected by our mistakes, 44 | and learning from the experience 45 | * Focusing on what is best not just for us as individuals, but for the 46 | overall community 47 | 48 | Examples of unacceptable behavior include: 49 | 50 | * The use of sexualized language or imagery, and sexual attention or 51 | advances of any kind 52 | * Trolling, insulting or derogatory comments, and personal or political attacks 53 | * Public or private harassment 54 | * Publishing others' private information, such as a physical or email 55 | address, without their explicit permission 56 | * Other conduct which could reasonably be considered inappropriate in a 57 | professional setting 58 | 59 | ## Enforcement Responsibilities 60 | 61 | Community leaders are responsible for clarifying and enforcing our standards of 62 | acceptable behavior and will take appropriate and fair corrective action in 63 | response to any behavior that they deem inappropriate, threatening, offensive, 64 | or harmful. 65 | 66 | Community leaders have the right and responsibility to remove, edit, or reject 67 | comments, commits, code, wiki edits, issues, and other contributions that are 68 | not aligned to this Code of Conduct, and will communicate reasons for moderation 69 | decisions when appropriate. 70 | 71 | ## Scope 72 | 73 | This Code of Conduct applies within all community spaces, and also applies when 74 | an individual is officially representing the community in public spaces. 75 | Examples of representing our community include using an official e-mail address, 76 | posting via an official social media account, or acting as an appointed 77 | representative at an online or offline event. 78 | 79 | ## Enforcement 80 | 81 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 82 | reported to the community leaders responsible for enforcement at 83 | [INSERT CONTACT METHOD]. 84 | All complaints will be reviewed and investigated promptly and fairly. 85 | 86 | All community leaders are obligated to respect the privacy and security of the 87 | reporter of any incident. 88 | 89 | ## Enforcement Guidelines 90 | 91 | Community leaders will follow these Community Impact Guidelines in determining 92 | the consequences for any action they deem in violation of this Code of Conduct: 93 | 94 | ### 1. Correction 95 | 96 | **Community Impact**: Use of inappropriate language or other behavior deemed 97 | unprofessional or unwelcome in the community. 98 | 99 | **Consequence**: A private, written warning from community leaders, providing 100 | clarity around the nature of the violation and an explanation of why the 101 | behavior was inappropriate. A public apology may be requested. 102 | 103 | ### 2. Warning 104 | 105 | **Community Impact**: A violation through a single incident or series 106 | of actions. 107 | 108 | **Consequence**: A warning with consequences for continued behavior. No 109 | interaction with the people involved, including unsolicited interaction with 110 | those enforcing the Code of Conduct, for a specified period of time. This 111 | includes avoiding interactions in community spaces as well as external channels 112 | like social media. Violating these terms may lead to a temporary or 113 | permanent ban. 114 | 115 | ### 3. Temporary Ban 116 | 117 | **Community Impact**: A serious violation of community standards, including 118 | sustained inappropriate behavior. 119 | 120 | **Consequence**: A temporary ban from any sort of interaction or public 121 | communication with the community for a specified period of time. No public or 122 | private interaction with the people involved, including unsolicited interaction 123 | with those enforcing the Code of Conduct, is allowed during this period. 124 | Violating these terms may lead to a permanent ban. 125 | 126 | ### 4. Permanent Ban 127 | 128 | **Community Impact**: Demonstrating a pattern of violation of community 129 | standards, including sustained inappropriate behavior, harassment of an 130 | individual, or aggression toward or disparagement of classes of individuals. 131 | 132 | **Consequence**: A permanent ban from any sort of public interaction within 133 | the community. 134 | 135 | ## Attribution 136 | 137 | This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), 138 | version 2.0, available at 139 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 140 | -------------------------------------------------------------------------------- /Contribute by Forking.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | # How to Contribute 4 | 5 | Before making any contributions, please ensure you have read our [Code of Conduct and Contributing Guidelines](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/CONTRIBUTING.md). 6 | 7 | ## Getting started guidelines 8 | 9 | - Take a look at the existing [Issues](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/issues) or [create a new issue](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/issues/new)! 10 | 11 | - [Fork the Repo](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/fork). Then, create a branch for any issue that you are working on. Finally, commit your work. 12 | 13 | - Create a Pull Request. This will be promptly reviewed and given suggestions for improvements by the community. 14 | 15 | - Add screenshots to your Pull Request when necessary to help us understand the effects of the changes proposed in your PR. 16 | 17 | ## Making contributions via GitHub 18 | 19 | You can make simple contribution like 20 | - Fixing grammar mistakes or typos 21 | - Editing or suggesting changes to the listed content 22 | - As well as contributing to the content and resources of the repo. 23 | - You can also ask a question or give an answer to an already asked question on the [discussion page](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/discussions) 24 | 25 | This [video](https://www.youtube.com/watch?v=dc6ZQEa3i1c) explains how you can make a contribution right on GitHub. 26 | 27 | ## How to make a Pull Request (PR) 28 | 29 | This guide was a modification of the [Microsoft 365 Platform Community Blog: How to contribute guide](https://pnp.github.io/blog/post/contribute-blog/) 30 | 31 | 1. Install [Visual Studio Code](https://code.visualstudio.com/) 32 | 33 | 1. Create a Git (not GitHub) account 34 | 35 | * Open the terminal in Visual Studio Code 36 | * Type `git --version` in a directory of your choice - you should see the version of Git that you downloaded. If you see an error, close and reopen VS Code and try again. 37 | * Set your user name with 38 | `git config --global user.name " "` - replace the `` with the real values 39 | * Set your email address with 40 | `git config --global user.email ""`- replace the `` with the real values (your email address should match the one with which you signed up for your GitHub account) 41 | 42 | 1. Fork this repository to create a copy in your GitHub account: 43 | 44 | * Open [Bennykillua/Getting-started-in-Technical-Writing](https://github.com/Bennykillua/Getting-started-in-Technical-Writing) (this repository) 45 | * Select **Fork** 46 | * Make a [Fork](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/fork) --> The URL of your fork is now `https://github.com//blog/` 47 | 48 | 49 | 1. Clone the repository 50 | 51 | Now you want to clone the repository so you have it locally available: 52 | ![fork repository](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Repo-Images/fork.png) 53 | 54 | * Select **Code** 55 | * Copy the URL (it is `https://github.com//blog.git`) 56 | * Open the terminal in VS Code 57 | * Navigate to a directory where you want to clone the repository 58 | * Type `git clone ` 59 | 60 | 7. Make chnages 61 | 62 | * in case you need some help on how markdown works, check out this [website](https://www.markdowntutorial.com/) or learn how to write in markdown using these [resources](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Learning%20Markdown.md) 63 | 64 | 8. Commit and push your changes to your fork 65 | 66 | Whenever you want to upload your changes to your remote fork: 67 | 68 | * type `git add .` (yes, there is a space (` `) between `add` and the `.`) - this adds all changes to staging area 69 | * type `git commit -m "YOUR COMMIT MESSAGE"` - this will commit your changes with the messages 70 | * type `git push` to push the changes to your remote fork 71 | 72 | 9. Pull request 73 | 74 | You will now want to (kindly) ask the repository maintainers to pull in your changes. You do that with a pull request: 75 | 76 | * Open [Bennykillua/Getting-started-in-Technical-Writing](https://github.com/Bennykillua/Getting-started-in-Technical-Writing) (this repository) 77 | * Select **Pull requests** 78 | * Select **New pull request** 79 | * Select **compare across forks** 80 | * Select your fork from the **head repository** 81 | * Select **Compare & pull request** 82 | 83 | ## PR Guides 84 | - Please give your PR a descriptive title 85 | - Commit messages should be meaningful and descriptive as possible. 86 | - Describe what's in the PR with 87 | - You can always switch to **Preview** to see how it looks like 88 | 89 | A maintainer will review your pull request and merge your changes. Otherwise, it will be given constructive feedback and suggestions for the changes 🏆 90 | 91 | This repository is maintained by volunteers in their free time, please be kind. Everyone is doing their best to keep things moving forward. 92 | 93 | **Congratulations!** You've made your first contribution to [Getting-started-in-Technical-Writing Repo](https://github.com/Bennykillua/Getting-started-in-Technical-Writing) 🙌🏼 94 | 95 | 96 | ## Issues 97 | 98 | In order to discuss changes, you are welcome to [open an issue](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/issues/new) about what you would like to contribute or see in this repo. 99 | 100 | ## want to ask a question? 101 | 102 | Check out the [dicussion page](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/discussions) 103 | 104 | ## Need to contact someone? 105 | 106 | Please reach out to me on Twitter: [Benny Ifeanyi](https://twitter.com/Bennykillua) 107 | 108 | Please do give this repo a ⭐ 109 | -------------------------------------------------------------------------------- /Contributing to open source as a technical writer.md: -------------------------------------------------------------------------------- 1 | # Contributing to open source as a technical writer 2 | 3 | Open Source is a term used to describe softwares whose original source code are freely available, can be redistributed, and also modified. Open Source embodies a spirit of collaboration, transparency, and community-oriented contributions, among other things. 4 | 5 | Check [here](https://benny.hashnode.dev/how-to-contribute-to-open-source-projects-as-a-non-coder#:~:text=you%20to%20contribute.-,Open%20Source,-Projects) to learn more and find open source projects. 6 | 7 | ## How to find open source projects looking for docs contribution? 8 | 9 | - [Use GitHub/GitLab topics to find docs projects](https://opensource.com/article/22/10/how-to-contribute-hacktoberfest?sc_cid=7016000000127ECAAY#:~:text=GitHub%20search%20syntax.-,Find%20non%2Dcode,-issues%20at%20Hacktoberfest) 10 | 11 | - [List of Open Source Projects with Documentation Opportunities by Amruta Ranade](https://amrutaranade.com/2018/03/21/list-of-open-source-projects-that-accept-docs-contributions/) 12 | 13 | - [Open-Source Projects for Technical Writers by Kesi Parker](https://medium.com/technical-writing-is-easy/open-source-projects-for-technical-writers-de53fb3dd4c9) 14 | 15 | ## Resources 16 | 17 | - [How to Contribute to Open Source Projects as a Non-Coder? by Ifeanyi Benny Iheagwara](https://benny.hashnode.dev/how-to-contribute-to-open-source-projects-as-a-non-coder) 18 | - [How to contribute to Hacktoberfest 2022 by Ifeanyi Benny Iheagwara](https://opensource.com/article/22/10/how-to-contribute-hacktoberfest) 19 | - [The Technical Writers Guide to Contributing to Open Source Projects by Edidiong Asikpo (Didi)](https://edidiongasikpo.com/the-technical-writers-guide-to-contributing-to-open-source-projects) 20 | - [How to Contribute to Open Source Projects – A Beginner's Guide by Hillary Nyakundi](https://www.freecodecamp.org/news/how-to-contribute-to-open-source-projects-beginners-guide/) 21 | - [Making Your First Open Source Contribution: A Beginner's Guide by Michael Asiedu](https://www.michaelasiedu.com/making-your-first-open-source-contribution-a-beginners-guide) 22 | - [Contributing to Open Source Beyond Software Development by Ifeanyi Benny Iheagwara](https://klarasystems.com/articles/contributing-to-open-source-beyond-software-development/) 23 | - [Reader question: Contributing docs to open source projects by Amruta Ranade](https://amrutaranade.com/2018/06/17/reader-question-contributing-docs-to-open-source-projects/) 24 | 25 | ## Hacktobestfest 26 | - [Preparing for Hacktobestfest](https://tome.app/cloudpuff/hacktoberfest-cln4nli9l04gxmz7bn7gfzfii) 27 | 28 | ## Open Source Projects 29 | - [Updating Airbyte Documentation](https://docs.airbyte.com/contributing-to-airbyte/writing-docs) 30 | - [Ansible](https://github.com/ansible/ansible/issues?q=is%3Aissue+is%3Aopen+label%3Adocs) 31 | - [docToolchain](https://github.com/docToolchain/docToolchain/issues) you can also start by creating [tutorials for docToolChain](https://github.com/docToolchain/tutorials) 32 | - [Ansible OS contribution](https://github.com/orgs/ansible-community/projects/3/views/1) 33 | - [Microsoft Docs](https://techcommunity.microsoft.com/t5/itops-talk-blog/how-you-can-contribute-to-open-source-projects-on-github/ba-p/1475375) 34 | - [JSON Schema Ambassadors](https://json-schema.org/blog/posts/json-schema-ambassadors) 35 | 36 | - [numpy-newsletter issues](https://github.com/numpy/numpy-newsletter/issues) 37 | 38 | ## Open Source Internship 39 | 40 | - [Google's Season of Docs](https://developers.google.com/season-of-docs) 41 | 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 42 | - [Google Season Of Docs: Everything You Need To Know To Get Accepted (TCCS #7) by Linda Ikechukwu](https://www.everythingtechnicalwriting.com/get-into-google-season-of-docs/) 43 | - [How to crack Google season of docs 2022 application stage by Nwokocha Wisdom Maduabuchi](https://wise4rmgodadmob.medium.com/how-to-crack-google-season-of-docs-2022-application-stage-ee248c8425de) 44 | - [How to Crack the Google Season of Docs Application Process for 2020 by Edidiong Asikpo (Didi)](https://edidiongasikpo.com/how-to-crack-the-google-season-of-docs-application-process-for-2020) 45 | - [Google Season of Docs: What it is and how to get in by Gbadebo Bello ](https://docs.google.com/presentation/d/1An3Y2hWmbJnRUcJ8Vn17dIM4lXUvziOqooBx64e-WKE/edit#slide=id.g11a712d418c_1_6) 46 | - [Why you should participate in Google Season of Docs by Amruta Ranade](https://amrutaranade.com/2019/05/10/why-you-should-participate-in-google-season-of-docs/) 47 | - [Getting Accepted into Google Season of Docs 2024: My Personal Journey by Blessing Anyebe](https://medium.com/@anyebeblessing737/getting-accepted-into-google-season-of-docs-2024-my-personal-journey-b029afbe724e) 48 | #### Examples Proposals 49 | - [Google Season of Docs proposal for VLC](https://docs.google.com/document/d/1sjHn5OGVZB0EbWHFL9_9Ty63oCF2itlYww2bf9Qhwtc/edit) 50 | - [GSoD 2020 Proposal: Improving Wikimedia's onboarding processes and documentation standards](https://phabricator.wikimedia.org/T255360) 51 | - [[2020] Season of Docs // Free resource for writing proposals](https://techwriting.ck.page/writing-proposals) 52 | - [tech writer guide](https://developers.google.com/season-of-docs/docs/tech-writer-guide) 53 | - [Gbadebo Bello's Propsal](https://res.cloudinary.com/gbahdeyboh/image/upload/v1647777013/Screenshot_2022-03-20_at_12.49.54_PM_kwejo8.png) 54 | - [Gbadebo's GSoD 2020 Proposal: Improving Wikimedia's onboarding processes and documentation standards](https://phabricator.wikimedia.org/T255360) 55 | - [Nwokocha wisdom's GSoD](https://docs.google.com/document/d/1wzpZ5mIEqd30kuZOnLECIpRp3f_cTGwCdkepI6znoaM/edit) 56 | 57 | 58 | 59 | - [Outreachy](https://www.outreachy.org/) 60 | Outreachy provides internships in open source and open science to people subject to systemic bias and impacted by underrepresentation in the technical industry where they are living. 61 | - [Get the most out of your Outreachy Intern application process by Joannah Nanjekye](https://www.freecodecamp.org/news/get-the-most-out-of-your-outreachy-application-process-937d4a8ab4bf) 62 | - [How I got into Mozilla’s Outreachy open source internship program by Shubheksha](https://www.freecodecamp.org/news/outreachy-what-how-why-4fb60d10a228) 63 | - [Outreachy Internship: My Experience by Nmeso](https://medium.com/@nmesoegwuekwe/outreachy-internship-my-experience-aecb3fb2791b) 64 | - [Everyone Struggles: struggles as an intern for the Outreachy internships by Nmeso](https://medium.com/@nmesoegwuekwe/everyone-struggles-c8c33233a764) 65 | - [Getting into outreachy by Nmeso](https://nmesoegwuekwe.github.io/getting-into-outreachy/) 66 | - [Outreachy Dreams: My Journey of Failing, Learning, and Succeeding by Osetiemoria Ebelubhuhi](https://medium.com/@ebelubhuhiose/outreachy-dreams-my-journey-of-failing-learning-and-succeeding-c725019bd404) 67 | 68 | 69 | - [GNOME OPW Applicants](https://wiki.gnome.org/GnomeWomen/OutreachProgram2012#Outreach_Program_for_Women) GNOME Outreach Program for Women internships 70 | - [Suggestions for GNOME OPW Applicants by Anita Kuno](https://web.archive.org/web/20130410022646/http://anteaya.info/blog/2013/03/29/suggestions-for-gnome-opw-applicants/) 71 | 72 | -------------------------------------------------------------------------------- /Contributing to publications as a technical writer.md: -------------------------------------------------------------------------------- 1 | # Contributing to publications as a technical writer 2 | 3 | You can contribute by writing for a few publications. Though you wouldn't be paid, you get visibility and a chance to share your knowledge with a broader audience while being recognized as a subject matter expert. The best part is that most of these publications have in-house editors, so you get better at writing. 4 | 5 | For paid opportunities, please check out the [getting paid session](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/README.md) 6 | 7 | ## Publications 8 | - [FreeCodeCamp](https://www.freecodecamp.org/news/how-to-write-for-freecodecamp/) apply [here](https://www.freecodecamp.org/news/developer-news-style-guide/) 9 | - [Microsoft 365 Platform Community Blog](https://pnp.github.io/blog/post/contribute-blog/) 10 | - [Towards Data Science](https://towardsdatascience.com/questions-96667b06af5) 11 | - [Analytics Vidhya](https://medium.com/analytics-vidhya/why-write-for-analytics-vidhya-6c7ea8f0aeef) 12 | - [Opensource.com](https://opensource.com/writers) 13 | - [Write the docs Kenya hashnode](https://drive.google.com/drive/folders/1ejHyEvkJCfnvQ3T9sSdHqElI8JxBfczM) 14 | - [Contribute to Towards AI](https://contribute.towardsai.net/) 15 | - [99design](https://99designs.com/blog/write-for-us/) 16 | - [Serverless360.com Azure community initiative.](https://www.serverlessnotes.com/docs/interested-to-contribute) 17 | - [Section EngEd Community Contribution](https://github.com/Bennykillua/engineering-education).. [Form](https://docs.google.com/forms/d/e/1FAIpQLSfTbj3kqvEJEb5RLjqJurfbHa8ckzQx0CjRzaizblue9ZOK5A/viewform?usp=sf_link) 18 | - [Javascript Works](https://javascript.works-hub.com/learn/write-content-for-javascript-works-fe7a7) 19 | - [Contribute to stackabuse](https://stackabuse.com/) 20 | - [Write for projectpro](https://www.projectpro.io/write-for-projectpro) 21 | - [Better Programming](https://betterprogramming.pub/write-for-us-5c4bcba59397) 22 | - [What is Layer5 Writing Program?](https://layer5.io/community/handbook/writing-program) 23 | - [Superpath Slack Community](https://superpath.slite.page/p/uxi28Hdkunadzo/Guest-Contributions) 24 | - [The ML pracitioner](https://medium.com/the-ml-practioner/write-for-us-497a299d97a0) 25 | - [Maven's Medium publication, Learning Data!](https://medium.com/learning-data/how-to-get-your-work-published-by-learning-data-with-maven-analytics-7df21e466a3e) 26 | - [Write for Data Engineer Things](https://blog.det.life/write-for-data-engineer-things-32dc9294c5db) 27 | - [Write for KDnuggets]([https://www.kdnuggets.com/](https://www.kdnuggets.com/2019/11/write-for-kdnuggets.html)) or Submit your blog via submissions@kdnuggets.com 28 | 29 | -------------------------------------------------------------------------------- /Contributor.md: -------------------------------------------------------------------------------- 1 | ## Acknowledgements and Contributors 2 | 3 | This project exists thanks to all the people who contribute! ❤️ 💙 4 | 5 | celebrate 6 | 7 | ## Why Contributions Matter 8 | 9 | Without contributions, a lot of technology you use today wouldn't exist. 10 | 11 | Vist our list of [contributors here](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/graphs/contributors) 12 | 13 | ## How to contribute? 14 | 15 | Before making any contributions, please take a look at our [Code of Conduct and the Contributing Guidelines](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/CONTRIBUTING.md). 16 | 17 | Dont know how to make a contribution? Learn how to make one [here](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Contribute%20by%20Forking.md). 18 | -------------------------------------------------------------------------------- /Docs as Code.md: -------------------------------------------------------------------------------- 1 | 2 | # Docs as Code, documentation, APIs, and everything in between 3 | 4 | You can find documentation courses [here](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Technical%20Writing%20Courses.md) 5 | 6 | ## Docs as Code 7 | 8 | Docs-as-code refers to handling your documentation the same way programmers handle code. This method is ideal for technical teams since everyone creates documents using the same tools, procedures, and workflows that they utilize while developing software. 9 | 10 | It comprises of and is not limited to 11 | - Version control using Git 12 | - collaboration and review 13 | - Consistent design. 14 | - Automated testing, building, and delivery. 15 | - Issue tracking. 16 | - Use of plain-text markup (Markdown, reStructuredText, AsciiDoc). 17 | 18 | ## Tools 19 | - [VitePress](https://vitepress.dev/) 20 | 21 | ## Documentation 22 | 23 | 24 | ## Resources 25 | 26 | - [APIS YOU WON'T HATE](https://apisyouwonthate.com/) 27 | - [Starting Docs in a Startup: A First-in-the-Door Experience](https://www.youtube.com/watch?v=LLYdszgk4Bs) 28 | - [VSCode setup for technical writers by Lornajane](https://lornajane.net/posts/2022/vscode-setup-for-technical-writers?utm_campaign=Everything%20Technical%20Writing%20Newsletter&utm_medium=email&utm_source=Revue%20newsletter) 29 | - [Tips for writing SaaS documentation](https://thisisimportant.net/posts/tips-for-writing-saas-documentation/) 30 | - [This is important: Tech Writing](https://thisisimportant.net/topics/tech-writing/) 31 | - [Getting Started in API Documentation Writing by Robert Delwood](http://writeonce.org/starting_as_a_programmer_writer.php) 32 | - [What is a Static Site Generator? And 3 ways to find the best one by Phil Hawksworth](https://www.netlify.com/blog/2020/04/14/what-is-a-static-site-generator-and-3-ways-to-find-the-best-one/) 33 | - [The Best Content to Supplement Your API Documentation by Karl Hughes](https://apisyouwonthate.com/blog/supplementing-documentation) 34 | - [Learning API Documentation](https://idratherbewriting.com/category-api-doc/) 35 | - [A Technical Writer's Introduction To Docs As Code by Linda Ikechukwu](https://www.everythingtechnicalwriting.com/dosc-as-code/) 36 | - [Docs-as-code tools](https://idratherbewriting.com/learnapidoc/pubapis_docs_as_code.html) 37 | - [Docs as Code (Trends to follow or forget) by Tom Johnson](https://idratherbewriting.com/trends/trends-to-follow-or-forget-docs-as-code.html) 38 | - [Building Docs with docToolchain: A Quickstart Guide by Ifeanyi Benny Iheagwara](http://doctoolchain.org/tutorials/01_Tutorials/010_Quickstart.html) 39 | - [Part 1 Part 1 - Creating a blog with Hugo, Github and Azure Static Web Apps](https://blog.pensplace.co.uk/post/creating-a-blog-with-hugo-github-and-azure-static-web-sites/) 40 | - [Part 2 Creating a blog with Hugo, Github and Azure Static Web Apps by Pen](https://blog.pensplace.co.uk/post/part-2-creating-a-blog-with-hugogithub-and-azure-static-websites/) 41 | - [Much Ado About Documentation Structure by Linda Ikechukwu](https://www.everythingtechnicalwriting.com/much-ado-about-software-documentation-structure/) 42 | - [Defining an efficient documentation structure](https://www.iodigital.com/en/history/foreach/defining-an-efficient-documentation-structure) 43 | - [Writing Code Examples for Technical Documentation by Brian Murray](https://www.youtube.com/watch?v=_gtzUpvGfXY) 44 | - [Working with APIs by Knowledge Owl](https://support.knowledgeowl.com/help/working-with-apis) 45 | - [Getting Started in API Documentation Writing by Robert Delwood](http://writeonce.org/starting_as_a_programmer_writer.php) 46 | - [Moved my blog from WordPress to Jekyll by Tom Johnson](https://idratherbewriting.com/2015/05/29/moved-my-blog-from-wordpress-to-jekyll/) 47 | - [Thoughts on docs-as-code after 3 years -- it works! by Tom Johnson](https://idratherbewriting.com/2018/07/03/docs-as-code-after-three-years/) 48 | - [Learning API docs by stealth by Jody Winter](https://jodywinter.com/2021/05/08/learning-api-docs-by-stealth/) 49 | - [Open source API Documnetations tools and why they matter by Luke Russell](https://blog.stoplight.io/open-source-api-documentation-tools-and-why-they-matter) 50 | - [Recording of Docs-as-code tools and workflows presentation by Tom Johnson](https://idratherbewriting.com/2018/03/09/docs-as-code-tools-and-workflows-denver-presentation/#slides) 51 | - [9 Great API and Developer Documentation Examples by Adam DuVander](https://everydeveloper.com/developer-documentation-examples/) 52 | - [A beginner guide to API documentation by Blessing Anyeba](https://kwennb.hashnode.dev/beginners-guide-to-api-documentation) 53 | 54 | -------------------------------------------------------------------------------- /Empower Her X Non Tech in Tech.md: -------------------------------------------------------------------------------- 1 | # Empower Her Community in collaboration with Non Tech in Tech Bootcamp 2 | 3 | Read this article to learn more about the [bootcamp](https://nontechintech.substack.com/p/nontechnicalbootcamp?r=k766r&s=w&utm_campaign=post&utm_medium=web&utm_source=direct) 4 | 5 | ## Empower Her Community 6 | 7 | A female community seeing to the growth and progress of women in tech. You can join the slack group [here](https://linktr.ee/EmpowerHerCommunity). 8 | 9 | ## Non Tech in Tech 10 | 11 | A community of Non-techies in Africa. You can join the slack group [here](https://join.slack.com/t/nontechintech/shared_invite/zt-1elj2fo4m-mi0HWRhkC5R8jjkxw73ikg) 12 | 13 | ## Tutors 14 | 15 | - Benny Ifeanyi Iheagwara - [Twitter](https://twitter.com/Bennykillua) [GitHub](https://github.com/Bennykillua) 16 | 17 | - Blessing Anyebe - [Twitter](https://twitter.com/KwennB) 18 | 19 | - Pelumi Timonwa Akintokun - [Twitter](https://twitter.com/timonwa_) [GitHub](https://github.com/timonwa) 20 | 21 | - Segun Light Olumide - [Twitter](https://twitter.com/wonexo) 22 | 23 | Learn more [here](https://twitter.com/empowerhercom/status/1554066239047274498?s=20&t=FpcUvRbr0vroejf1fneanw). 24 | 25 | ## Resources used 26 | 27 | - [Introduction to Technical Writing by Benny and Blessing](https://docs.google.com/presentation/d/1iQjS8ng7s8cNnbX_-pmcaVX_fiJrZTLdcDvdKSySq9s/edit?usp=sharing) 28 | 29 | - [Technical Writing 102 by Benny and Blessing](https://docs.google.com/presentation/d/15qSEnL9TNgbgrNFrSIeE987ZwcRMG1auNwX5NyRLcFU/edit?usp=sharing) 30 | 31 | - [Tools used in Technical Writing by Benny, Blessing, and Timonwa](https://docs.google.com/presentation/d/1mtu9CryVeydr9y_YmL9PUAM5Sv_ZPO6pwDlPAiqsk7Q/edit?usp=sharing) 32 | 33 | - [The Writing Process by Blessing and Timonwa](https://docs.google.com/presentation/d/1p4ftBJtoDG02H4yRaxEBNWnuGllChiqm64qmpeIHYiA/edit?usp=sharing) 34 | 35 | - [Search Engine Optimization In Technical Writing by Blessing](https://docs.google.com/presentation/d/1xLdw45nrxWwARveF7e2cNq7HWQKX_2fYNNU23Lr7LF4/edit?usp=sharing) 36 | 37 | - [Open Source and the Real World by Benny, Blessing, and Timonwa](https://docs.google.com/presentation/d/19QLEWGtSAdsvFsHLWOdIlLx6hnI-M6ZcS8XcczEQhcE/edit?usp=sharing) 38 | 39 | 40 | ## Articles 41 | 42 | - [Fabusuyi deborah My experience at EHCXNTIT Technical Writing Bootcamp](https://medium.com/@fabusuyideborah03/my-experience-at-ehc-x-ntit-bootcamp-47fdae6baad3) 43 | 44 | - [Falomo sharon simisola](https://github.com/falsharion) [ Getting started in Technical Writing EHCXNTIT](https://falomosharon.hashnode.dev/getting-started-in-technical-writing) 45 | 46 | - [Folami Oluwapelumi](https://github.com/Pep7799) [My Experience at the EHC X NTIT Technical Writing Bootcamp](https://supergirlp.hashnode.dev/my-experience-at-the-empower-her-community-x-non-tech-in-tech-bootcamp) 47 | 48 | - [Teniola Olowookere](https://github.com/Teniola-theDev) [My Experience at the EHC X NTIT Technical Writing Bootcamp](https://teniolaxyz.hashnode.dev/my-experience-at-the-empower-her-community-x-non-tech-in-tech-bootcamp) 49 | 50 | - [Halimat Chisom](https://github.com/Chisomgold): [My Experience at the EHC X NTIT Technical Writing Bootcamp](https://medium.com/@gearthdexter/bootcamp-experience-with-empower-her-x-non-tech-in-tech-technical-writing-de590524c2ce) 51 | 52 | - [Mbah Uzoma What I learned at The Empower her Community and Non-Tech in Tech Bootcamp](https://amytex5.hashnode.dev/what-i-learned-during-the-empower-her-community-and-non-tech-in-tech-bootcamp) 53 | 54 | - [Francesca Akibu](https://github.com/ThisChes):[ Becoming A Technical Writer: My Experience at Empower Her Community X NTIT Bootcamp](https://medium.com/@francescaobadan01/becoming-a-technical-writer-my-experience-at-empower-her-community-x-ntit-bootcamp-e611e9fbf6a0) 55 | -------------------------------------------------------------------------------- /Interviews and getting paid.md: -------------------------------------------------------------------------------- 1 | 2 | # Resume, portfolio, interviews, and everything in between 3 | 4 | Check here out for [jobs and gigs](https://github.com/Bennykillua/Getting-started-in-Technical-Writing#getting-paid:~:text=everything%20in%20between-,Getting%20paid,-Paid%20Community%20Writer) 5 | 6 | ## Portfolio examples 7 | - [Zach Holman!'s blog](https://zachholman.com/) 8 | - [Video: 6 Inspiring Technical Writing Portfolios (+ my new portfolio) by Amruta Ranade](https://www.youtube.com/watch?v=crePAmhdpww) 9 | - [My Technical Writing Portfolio (ft. GitHub and open source projects) by Amruta Ranade](https://www.youtube.com/watch?v=68ddwfpXHrE) 10 | 11 | ## Job-Related Questions about Technical Writing 12 | 13 | Technical writing careers are often a mystery to those on the outside. What do technical writing jobs involve? What is the industry like? What is the career path of a technical writer, and what challenges do technical writers face? This [article by Tom Johnson](https://idratherbewriting.com/2008/02/16/technical-writing-careers-answering-13-questions-about-technical-writing-jobs/) explains it all. 14 | 15 | ## Resources 16 | 17 | - [Where and How to Find UX Writing, Content Design, and Content Strategy Jobs By Scott Kubie](https://kubie.co/blog/where-to-find-ux-writing-content-design-jobs/) 18 | 19 | - [ Finding Opportunities as an Entry Level Technical Writer by Karl Hughes](https://draft.dev/learn/finding-opportunities-as-an-entry-level-technical-writer) 20 | 21 | - [Technical Writer Interview: What To Expect From Personal Experience by Linda Ikechukwu](https://www.everythingtechnicalwriting.com/technical-writer-interview/) 22 | 23 | - [How To Create A Technical Writing Portfolio by Linda Ikechukwu](https://www.everythingtechnicalwriting.com/technical-writing-portfolio/) 24 | 25 | - [Resume Design Guide by John Paz](https://medium.com/@SrContentDesign/resume-design-guide-860633bd4f) 26 | - [Resume Design Guide — Chapter 1 How Resumes Work](https://medium.com/@SrContentDesign/resume-design-guide-chapter-2-bf9c55bc9387) 27 | - [Resume Design Guide — Chapter 2 What Makes a Great Resume](https://medium.com/@SrContentDesign/resume-design-guide-chapter-2-bf9c55bc9387) 28 | - [Resume Design Guide — Chapter 3 🚩Resume Red Flags🚩](https://medium.com/@SrContentDesign/resume-design-guide-chapter-3-98d6e79e307f) 29 | - [Resume Design Guide — Chapter 4 Design A Winning Resume](https://medium.com/@SrContentDesign/resume-design-guide-chapter-4-4ad63b50d237) 30 | - [video: TechWriting.tips - Resume Design for People Who Want Jobs (ft. John Paz)](https://www.youtube.com/watch?v=I4goQZl0Nbs) 31 | 32 | - [Tom Johnson’s](https://idratherbewriting.com/aboutme/) How to get a job in technical writing series: 33 | - [Learn the basics of technical writing (TW Job)](https://idratherbewriting.com/2009/12/18/get-a-job-in-technical-writing-step-1-learn-the-basics-of-technical-writing/) 34 | - [Get real experience doing technical writing (TW Job)](https://idratherbewriting.com/2009/12/19/get-a-job-in-technical-writing-step-2-get-real-experience-doing-technical-writing/) 35 | - [Learn some tools (TW Job)](https://idratherbewriting.com/2009/12/20/get-a-job-in-technical-writing-step-3-learn-some-tools/) 36 | - [Put together a portfolio (TW Job)](https://idratherbewriting.com/2009/12/21/get-a-job-in-technical-writing-step-4-put-together-a-portfolio/) 37 | 38 | 39 | - [2 Ways To Make Money As A Freelance Technical Writer by Linda Ikechuwkwu](https://www.everythingtechnicalwriting.com/freelance-technical-writing/) 40 | - [Writing a cover letter for a technical writing job by Amruta Ranade](https://amrutaranade.com/2018/01/24/writing-a-cover-letter-for-a-technical-writing-job/) 41 | - [Crafting your technical writing resume by Amruta Ranade](https://amrutaranade.com/2018/01/17/crafting-your-technical-writing-resume/) 42 | - [How to conduct an effective job search in technical writing by Amruta Ranade](https://amrutaranade.com/2018/01/10/how-to-conduct-an-effective-job-search-in-technical-writing/) 43 | - [Cover Letter Template for your next job 💪🏽 by Dillion Megida](https://dillionmegida.com/p/cover-letter-template/) 44 | - [Engineering Leadership by Gregor Ojstersek](https://newsletter.eng-leadership.com/t/preparing-for-interviews?utm_source=substack&utm_medium=email) 45 | 46 | 47 | -------------------------------------------------------------------------------- /Learning Git.MD: -------------------------------------------------------------------------------- 1 | # Git commands 2 | 3 | ## Installation 4 |
5 | Find out more 6 | 7 | 
$ git --version
8 | 9 |
10 | 11 | --- 12 | 13 | ## Git configuration 14 |
15 | Find out more 16 | 17 | 
$ git config --global user.name "[username]"
18 | 19 | 
$ git config --global user.email "[valid-email]"
20 | 21 | 
$ git config --global color.ui auto
22 | 23 |
24 | 25 | --- 26 | 27 | ## Working with Local Branch 28 |
29 | Find out more 30 |
31 | 32 | - Create a branch 33 | 34 | 
$ git branch
35 | 36 |
37 | 38 | - Display all branches 39 | 40 | 
$ git branch -a
41 | 42 |
43 | 44 | - Delete a branch 45 | 46 | 
$ git branch -d
47 | 48 | 49 |
50 | 51 | - Delete remote branch 52 | 53 | 
$ git push origin –delete [branchName]
54 | 55 | 56 |
57 | 58 | - Checkout an existing branch 59 | 60 | 
$ git checkout
61 | 62 | 63 |
64 | 65 | - Checkout and create a new branch 66 | 67 | 
$ git checkout -b
68 | 69 | 70 |
71 | 72 | - Merge a branch into an active branch 73 | 74 | 
$ git merge
75 | 76 | 77 |
78 | 79 | - Recover a deleted file and prepare it for commit 80 | 81 | 
$ git checkout
82 | 83 | 84 |
85 | 86 | --- 87 | 88 | ## Working With Remote Repositories 89 |
90 | Find out more 91 | 92 | 
$ git remote add origin
93 | 94 | 95 |
96 | 97 | - git Clone 98 | 99 | 
$ git clone
100 | 101 | 102 |
103 | 104 | - git push 105 | 106 | 
$ git push -u origin master
107 | 108 | 109 |
110 | 111 | - git push 112 | 113 | 
$ git pull origin master
114 | 115 | 116 |
117 | 118 | - git fetch 119 | 120 | 
$ git fetch
121 | 122 |
123 | 124 | --- 125 | 126 | 127 | ## Working With Local Repositories 128 |
129 | Find out more 130 | 131 | 132 |
133 | 134 | - Create a new Folder 135 | 136 | 
$ mkdir test
137 | 138 | 139 |
140 | 141 | - Initialize Git 142 | 143 | 
$ cd test/
144 | 145 | 
$ git init
146 | 147 | 148 |
149 | 150 | - Create Readme file 151 | 152 | 
$ cat > Readme.md
153 | 154 | 155 |
156 | 157 | - Staging 158 | 159 | 
$ git add .
160 | 161 | 
$ git add
162 | 163 | 164 |
165 | 166 | - Check status 167 | 168 | 
$ git status
169 | 170 | 171 |
172 | 173 | - Committing staged files 174 | 175 | 
$ git commit -m "Commit message"
176 | 177 | 178 |
179 | 180 | - Remove file 181 | 182 | 
$ git rm
183 | 184 | 185 |
186 | 187 | - logs 188 | 189 | 
$ git rm
190 | 191 |
192 | 193 | --- 194 | 195 | ## Additional Commands 196 |
197 | Find out more 198 | 199 | 200 |
201 | 202 | - git stash 203 | 204 | 
$ git stash -u
205 | 206 | 207 |
208 | 209 | - brings the stashed work back to the working directory 210 | 211 | 
$ git stash pop
212 | 213 |
214 | 215 | - undoing changes 216 | 217 | 
$ git reset
218 | 219 | 
$ git clean -n
220 | 221 | 222 |
223 | 224 | - Define a tag 225 | 226 | 
$ git tag
227 | 228 | 229 |
230 | 231 | - git diff 232 | 233 | 
$ git diff
234 | 235 | 
$ git diff --staged
236 | 237 | 
$ git diff
238 | 239 |
240 | 241 | --- 242 | 243 | ## Resources 244 | - [GitHub for Beginners by Amruta Ranade](https://amrutaranade.com/2018/03/02/github-for-beginners/) 245 | - [Introduction to GitHub repo by GitHuB Skills](https://github.com/skills/introduction-to-github) 246 | - [Hello GitHub Actions by GitHub Skills](https://github.com/skills/hello-github-actions) 247 | - [Git and GitHub for Beginners - Crash Course](https://www.youtube.com/watch?v=RGOj5yH7evk) 248 | 249 | -------------------------------------------------------------------------------- /Learning Markdown.md: -------------------------------------------------------------------------------- 1 | 2 | # Markdowns 3 | 4 | Markdown is an incredibly powerful writing language that allows you create rich formatted text. 5 | 6 | ## Who created Markdown? 7 | 8 | John Gruber and Aaron Swartz in 2004. At the moment, Markdown is now one of the world’s most popular markup languages. 9 | 10 | Other examples of markup languages are HTML and reStructuredText. 11 | 12 | ## Simple Syntax in Markdowns 13 | 14 | ### Headings 15 | This is the syntax for creating various heading sizes: 16 | 17 | ``` 18 | # Heading Level 1 19 | 20 | ## Heading Level 2 21 | 22 | ### Heading Level 3 23 | 24 | #### Heading Level 4 25 | 26 | ##### Heading Level 5 27 | 28 | ###### Heading Level 6 29 | ``` 30 | This will display: 31 | 32 | # Heading Level 1 33 | 34 | ## Heading Level 2 35 | 36 | ### Heading Level 3 37 | 38 | #### Heading Level 4 39 | 40 | ##### Heading Level 5 41 | 42 | ###### Heading Level 6 43 | 44 | ## Creating a table of content 45 | ``` 46 | # Table of contents 47 | 1. [Introduction](#introduction) 48 | 2. [Some paragraph](#paragraph1) 49 | 1. [Sub paragraph](#subparagraph1) 50 | 3. [Another paragraph](#paragraph2) 51 | 52 | ``` 53 | This will display: 54 | 55 | # Table of contents 56 | 1. [Introduction](#introduction) 57 | 2. [Some paragraph](#paragraph1) 58 | 1. [Sub paragraph](#subparagraph1) 59 | 3. [Another paragraph](#paragraph2) 60 | 61 | ### Emphasis 62 | This is the process of giving prominence to a text or string of texts. It consists of bold, italics and bold italics 63 | ``` 64 | This is a **bold** text 65 | This is a **bold text** 66 | 67 | This is an *italic* text 68 | This is an *italic text* 69 | 70 | This is a ***bold italic*** text. 71 | This is a ***bold italic text***. 72 | ``` 73 | This will display: 74 | 75 | This is a **bold** text. 76 | This is a **bold text**. 77 | 78 | This is an *italic* text. 79 | This is an *italic text*. 80 | 81 | This is a ***bold italic*** text 82 | This is a ***bold italic text*** 83 | 84 | ### Links 85 | To create a link, use this syntax: 86 | ``` 87 | Check for the markdown cheat sheet at [Markdown Cheatsheet](https://www.markdownguide.org/cheat-sheet/) 88 | 89 | ``` 90 | 91 | This will display as: 92 | 93 | Check for the markdown cheat sheet at [Markdown Cheatsheet](https://www.markdownguide.org/cheat-sheet/) 94 | 95 | #### Email and url links 96 | To enable emails and urls appear as a link, wrap them in angle brackets: 97 | ``` 98 | 99 | 100 | ``` 101 | This will display as: 102 | 103 | 104 | 105 | 106 | 107 | 108 | ### Code 109 | To denote a word or a phrase as code, wrap it in backticks(``) 110 | 111 | ``` 112 | To list files and directories on the terminal, run `ls` 113 | ``` 114 | 115 | This will display: 116 | 117 | To list files and directories on the terminal, run `ls` command. 118 | # Resources 119 | - [Table Generator](https://www.tablesgenerator.com/markdown_tables) 120 | - [Markdown badges](https://github.com/Ileriayo/markdown-badges) 121 | - [The markdown guide](https://www.markdownguide.org/) 122 | - [Markdown emojis](https://gist.github.com/rxaviers/7360908) 123 | -------------------------------------------------------------------------------- /Learning Resources/Speak.md: -------------------------------------------------------------------------------- 1 | 2 | # Talks, conference, and speaking 3 | 4 | ## Where can you give a talk or workshop? 5 | 6 | - Write the Docs Kenya? fill this [form](https://docs.google.com/spreadsheets/d/1Hzygi9izMrQyL_EYWV5puf2hCK65cClsd3pacrFq61A/edit#gid=0) or contact wtdkenya@gmail.com 7 | 8 | - Wanna speak at [Let's Talk Technical Writing](https://twitter.com/writefortech)? send a dm. 9 | 10 | - Wanna speak at [Write the Docs Nigeria](https://twitter.com/NgDocs)? send a dm. 11 | 12 | - Wanna speak at [Write the Docs Kenya](https://www.meetup.com/wtd-kenya/) [Twitter](https://mobile.twitter.com/wtd_kenya). Check out their [event page](https://docs.google.com/spreadsheets/d/1Hzygi9izMrQyL_EYWV5puf2hCK65cClsd3pacrFq61A/edit#gid=0) and send a dm. 13 | 14 | - Keep an eye on the [Write the Docs Conferences site](https://www.writethedocs.org/conf/) to deliver a talk at either Write the Docs Portland, Prague, or Australia. 15 | 16 | - [sessionize.com](https://sessionize.com/login?ReturnUrl=%2Fapp%2Fspeaker%2Fdiscover) 17 | 18 | 19 | ## Resources 20 | 21 | - [On Conference Speaking by Hynek Schlawack](https://hynek.me/articles/speaking/) 22 | - [Designing Presentations by Idan Gazit](https://gazit.me/writing/designing-presentations/) 23 | - [How to prepare and write a tech conference talk by Lena Reinhard](https://wunder.schoenaberselten.com/2016/02/16/how-to-prepare-and-write-a-tech-conference-talk/) 24 | - [An Introvert’s Guide to Better Presentations: Improving your public speaking despite hating crowds by Matt Haughey](https://medium.com/@mathowie/an-introverts-guide-to-better-presentations-be7e772b2cb5) 25 | -------------------------------------------------------------------------------- /Learning Resources/Technical writing slides.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | # Slides 4 | 5 | A compilation of slides on technical writing. 6 | 7 | 8 | - [Introduction to Technical Writing by Benny Ifeanyi and Blessing Anyebe](https://docs.google.com/presentation/d/1Xog9--49aFvkN8scz4THnEjSJoETqUMBlobxcy1TCj4/edit?usp=sharing) 9 | 10 | - [Tools used in Technical Writing by Ifeanyi Benny, Timonwa Akintokun, and Blessing Anyebe](https://docs.google.com/presentation/d/1KNhdttM09kTQYFwWDHnHwdvWFIAs6QhuXhNVLrj89Kg/edit?usp=sharing) 11 | 12 | - [The Writing Process by Ifeanyi Benny, Timonwa Akintokun, and Blessing Anyebe](https://docs.google.com/presentation/d/1LY2pBYVKwTmDmrfCCPgTGxXAbfSEcrlo-3Mr0Y1r5g0/edit?usp=sharing) 13 | 14 | - [Search Engine Optimization In Technical Writing by Blessing Anyebe](https://docs.google.com/presentation/d/1xLdw45nrxWwARveF7e2cNq7HWQKX_2fYNNU23Lr7LF4/edit?usp=sharing) 15 | 16 | - [Open Source and the Real World by Ifeanyi Benny, Timonwa Akintokun, and Blessing Anyebe](https://docs.google.com/presentation/d/19QLEWGtSAdsvFsHLWOdIlLx6hnI-M6ZcS8XcczEQhcE/edit?usp=sharing) 17 | 18 | - [Monetizing your Technical Writing Skills by Timonwa Akintokun](https://docs.google.com/file/d/1iiEETIIgMfuXk9tvNjYb5fYJiVc9Wulh/edit?usp=docslist_api&filetype=mspresentation) 19 | 20 | - [Writing Style Guide by Ifeanyi Benny Iheagwara](https://docs.google.com/presentation/d/1XRg7x9DqsO525iRhU03F2pvJCNPOwPet9QX02ygaVMg/edit?usp=sharing) 21 | 22 | - [Write the Docs Prague 2022: Creating documentation for the African audience by Mustapha Rufai and Benny Ifeanyi Iheagwara](https://docs.google.com/presentation/d/1WE-8PFfDlEYMywA_Yl5ia54gleVuVXSR5WaUgQCVOKw/edit?usp=sharing). Here is the [video](https://www.youtube.com/watch?v=w2L3QoTnYbE) of the talk. 23 | 24 | 25 | # Tutor-based Videos 26 | 27 | A compilation of vidoes by various technical writers. 28 | 29 | - [Introduction to Open Source by Samson Goddy](https://www.youtube.com/watch?v=rflftNy7RV8) 30 | - [Introduction to writing style guides by Barrie](https://www.youtube.com/watch?v=KbDLPz0QvvU) 31 | - [Introduction to command line interface by Eze](https://www.youtube.com/watch?v=5V5JWDhe36k) 32 | - [Introduction to Knowledgebase by Oana](https://www.youtube.com/watch?v=p2Zzfs9L8Ek) 33 | - [Introduction to information architecture by Wisdom](https://www.youtube.com/watch?v=c23Yz2vCWxA) 34 | - [Introduction to Git and Github by Dillion](https://www.youtube.com/watch?v=f2S8UuDcFEQ) 35 | - [Introduction to Git and GitHub part 2 by Anita](https://www.youtube.com/watch?v=pIQlzo8Wkvs) 36 | - [Introduction to markdown by Idris](https://www.youtube.com/watch?v=8-gJmNPlanw) 37 | - [Introduction to Knowledgebase by Oana](https://youtu.be/p2Zzfs9L8Ek) 38 | - [How to use Google Document with Benny](https://youtu.be/LIU1SMVhQbo) 39 | - [Technical Writing Portfolio](https://youtu.be/eL_jAfO5Vr4) 40 | - [Intoduction to content marketing](https://youtu.be/pvxb49Kex1Q) 41 | - [Introduction to search engine optimization (SEO) by TeeFaith](https://youtu.be/c7wPmkD1Ii0) 42 | - [Introduction to quality assurance by Wisdom](https://youtu.be/KkslEb0TWik) 43 | -------------------------------------------------------------------------------- /Polygon/Polygon.adoc: -------------------------------------------------------------------------------- 1 | :jbake-title: New to Polygon? 2 | :jbake-type: page_toc 3 | :jbake-status: published 4 | :jbake-menu: arc42 5 | :jbake-order: 13 6 | :filename: \chapters\Polygon.adoc 7 | ifndef::imagesdir[:imagesdir: ../../images] 8 | 9 | :toc: 10 | 11 | [[section-introduction-and-goals]] 12 | = New to Polygon? 13 | 14 | Polygon is a scaling solution for public blockchains. Polygon PoS supports all the existing Ethereum tooling along with faster and cheaper transactions. 15 | 16 | == Types of Interaction on Polygon 17 | 18 | * https://docs.polygon.technology/docs/develop/getting-started[Polygon PoS chain] 19 | 20 | * https://docs.polygon.technology/docs/develop/ethereum-polygon/pos/getting-started[Ethereum + Polygon with PoS bridge] 21 | 22 | * https://docs.polygon.technology/docs/develop/ethereum-polygon/plasma/getting-started[thereum + Polygon with Plasma bridge] 23 | 24 | == Deploy Smart Contracts 25 | 26 | * Deploy your Contracts on Polygon 27 | ** https://docs.polygon.technology/docs/develop/alchemy[Using Alchemy] 28 | ** https://docs.polygon.technology/docs/develop/chainstack[Using Chainstack] 29 | ** https://docs.polygon.technology/docs/develop/quicknode[Using QuickNode] 30 | ** https://docs.polygon.technology/docs/develop/remix[Using Remix] 31 | ** https://docs.polygon.technology/docs/develop/truffle[Using Truffle] 32 | ** https://docs.polygon.technology/docs/develop/hardhat[Using Hardhat] 33 | 34 | * Configure the Web3 RPC-URL to https://rpc-mumbai.matic.today, _Everything else remains the same_ 35 | 36 | == What is a Blockchain? 37 | 38 | Simply put, Blockchain is a shared, immutable ledger for recording transactions, tracking assets and building trust. Head over to https://docs.polygon.technology/docs/home/new-to-polygon/blockchain-basics/blockchain[Blockchain Basics]to read more. 39 | 40 | 🎥 https://www.youtube.com/watch?v=rzvk2kdjr2I[Your first DApp] 41 | 42 | == What is a Sidechain? 43 | Think of a Sidechain as a clone of a "parent" blockchain, supporting transfer of assets to and from the main chain. It is simply an alternate to parent chain that creates a new blockchain with its own mechanism of creating blocks (consensus mechanism). Connecting a sidechain to a parent chain involves setting up a method of moving assets between the chains. 44 | 45 | 📄 https://hackernoon.com/what-are-sidechains-and-childchains-7202cc9e5994[Sidechains and Childchains] 46 | 47 | == Validator and delegator roles 48 | On the Polygon Network, you can be a validator or a delegator. See: 49 | 50 | * https://docs.polygon.technology/docs/validate/polygon-basics/who-is-validator[Who Is a Validator] 51 | 52 | * https://docs.polygon.technology/docs/validate/polygon-basics/who-is-delegator[Who Is a Delegator] 53 | 54 | == Architecture 55 | If your goal is to become a validator, it is essential that you understand the Polygon architecture. 56 | 57 | See https://docs.polygon.technology/docs/validate/validator/architecture[Polygon Architecture]. 58 | 59 | == Components 60 | 61 | To have a granular understanding of the Polygon architecture, see core components: 62 | 63 | * https://docs.polygon.technology/docs/contribute/heimdall/overview[Heimdall] 64 | 65 | * https://docs.polygon.technology/docs/contribute/bor/overview[Bor] 66 | 67 | * https://docs.polygon.technology/docs/contribute/contracts/stakingmanager[Contracts] 68 | 69 | == Codebases 70 | To have a granular understanding of the core components, see the codebases: 71 | 72 | * https://github.com/maticnetwork/heimdall[Heimdall] 73 | 74 | * https://github.com/maticnetwork/bor[Bor] 75 | 76 | * https://github.com/maticnetwork/contracts[Contracts] 77 | 78 | == How-tos 79 | 80 | === Node setup 81 | * https://docs.polygon.technology/docs/validate/validate/run-validator-ansible[Run a Validator Node with Ansible] 82 | 83 | * https://docs.polygon.technology/docs/validate/validate/run-validator-binaries[Run a Validator Node from Binaries] 84 | 85 | === Staking operations 86 | * https://docs.polygon.technology/docs/validate/validate/validator-staking-operations[Validator Staking Operations] 87 | 88 | * https://docs.polygon.technology/docs/validate/delegate[Delegate] 89 | -------------------------------------------------------------------------------- /Polygon/README.md: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /Productivity and everythin in between.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | # Productivity, writer's block, and everything in between 4 | 5 | ## Resources 6 | - [The Developer Advocacy Handbook by Christian Heilmann](https://developer-advocacy.com/) 7 | - [Who is Speaking On Your Behalf? by Prosper Otemuyiwa](https://dev.to/unicodeveloper/who-is-speaking-on-your-behalf-2c5e) 8 | - [Community Management 101: Everything You Wanted To Know About Building Your Community From Scratch by Alok Chowdhury](https://medium.com/strategic-content-marketing/community-management-101-everything-you-wanted-to-know-about-building-your-community-from-scratch-aafb539a55a9) 9 | - [Contentre: Technical writer behind the scence](https://blog.contentre.io/author/wendy/) 10 | - [Why and how tech writers should work on their technical skills by Tom Johnson and Amruta Ranade](https://app.stitcher.com/splayer/f/73517/55624504?size=large&variant=twittercard&autoplay=1&auto_play=true) 11 | - [3 Tricks to Overcome Writer's Block by Ryan Macklin](https://thegooddocsproject.dev/blog/3-tricks-to-overcome-writers-block/?utm_campaign=Everything%20Technical%20Writing%20Newsletter&utm_medium=email&utm_source=Revue%20newsletter) 12 | - [The Art of Asking Questions by Tom Johnson](https://idratherbewriting.com/2010/02/17/the-art-of-asking-questions/) 13 | - [Asking questions is more important than finding answers -- why? by Tom Johnson](https://idratherbewriting.com/2012/04/27/asking-questions-is-more-important-than-finding-answers-why/) 14 | - [Part 1: Introduction to influence on the web by Tom Johnson](https://idratherbewriting.com/web-and-workplace-influence/part1-introduction-to-influencers.html) 15 | - [A Day in the Life of a Contract Technical Writer in Australia by Amruta Ranade](https://amrutaranade.com/2018/04/18/a-day-in-the-life-of-a-contract-technical-writer-in-australia/) 16 | - [Collaboration and/in Technical Communication (from the Perspective of a Tech Comm PhD Student) by Amruta Ranade](https://amrutaranade.com/2018/04/11/collaboration-and-in-technical-communication-from-the-perspective-of-a-tech-comm-phd-student/) 17 | - [A Day in the Life of a Freelance Technical Writer by Amruta Ranade](https://amrutaranade.com/2018/04/04/a-day-in-the-life-of-a-freelance-technical-writer/) 18 | - [Sunk Cost Fallacy: Definition and Examples by Lindsay Kramer](https://www.grammarly.com/blog/sunk-cost-fallacy/?utm_source=BlogNL&utm_medium=email&utm_campaign=B2C_090322&utm_content=email) 19 | - [An Original Framework to Guide Discovery For Your Next Technical Writing Project by Todd Lewandowski](https://toddlewandowski.medium.com/an-original-framework-to-guide-discovery-for-your-next-technical-writing-project-89d18b8fc79a) 20 | - [What it’s like working with an editor by Giles Turnbull](https://www.usethehumanvoice.com/edit/?utm_campaign=Everything%20Technical%20Writing%20Newsletter&utm_medium=email&utm_source=Revue%20newsletter) 21 | - [Why You Should NOT Move in Silence: Why? Are you a thief? by Linda Ikechukwu](https://middleclassnigeriangirl.substack.com/p/why-you-should-not-move-in-silence?utm_medium=web) 22 | - [The Big Blog Promotion Checklist by Karl Hughes](https://draft.dev/learn/promotion) 23 | - [When to Quit by Ben Heim](https://medium.com/icarus-unbound/when-to-quit-7a4c363ba4ba) 24 | - [How I Hacked a Group of Hackers Operating on Nigerian Banks: A Tale of Nigeria's Cybersecurity State of Financial Institutions. by David S.](https://www.linkedin.com/pulse/how-i-hacked-group-hackers-operating-nigerian-banks-tale-sennaike/) 25 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | # Getting Started in Technical Writing 4 | 5 | A compilation of resources for anyone who wants to get started or learn more about technical writing. 6 | 7 | We would greatly appreciate a star if you like our project ⭐ 8 | 9 | # What is Technical Writing? 10 | 11 | One of my favorite explanations of technical writing comes from [Tom Johnson](https://www.linkedin.com/in/tomjoht/), who defines it as the interaction of simplicity and complexity. 12 | 13 | I'd define technical writing as a form of writing where the author discusses a specific topic that calls for direction, instruction, or explanation. 14 | 15 | To learn more about technical writing, explore the [resources](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Technical%20Writing%20Resources.md) 16 | and [discussion page](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/discussions) 17 | 18 | # Contributing 19 | 20 | This project exists thanks to all the people who contribute! ❤️ 💙 21 | 22 | View our list of contributors [here](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Contributor.md) 23 | 24 | ## How to contribute? 25 | 26 | Before making any contributions, please take a look at our [Code of Conduct and the Contributing Guidelines](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/CONTRIBUTING.md). 27 | 28 | Wanna make a contribution but don't know how? Check out the [how to contribute page](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Contribute%20by%20Forking.md). 29 | 30 | # Learning resource 31 | 32 | - [Technical Writing Resources](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Technical%20Writing%20Resources.md) 33 | 34 | - [Technical Writing and documentation Courses](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Technical%20Writing%20Courses.md) 35 | 36 | - [Docs as Code, documentation, APIs, and everything in between](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Docs%20as%20Code.md) 37 | 38 | - [Search Engine Optimization (SEO)](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/SEO.md) 39 | 40 | - [Learning markdown](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Learning%20Markdown.md) 41 | 42 | - [Simple Git commands](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Learning%20Git.MD) 43 | 44 | - [Contributing to open source as a technical writer](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Contributing%20to%20open%20source%20as%20a%20technical%20writer.md) 45 | 46 | - [Contributing to publications as a technical writer](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Contributing%20to%20publications%20as%20a%20technical%20writer.md) 47 | 48 | - [Resume, portfolio, interviews, and everything in between](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Interviews%20and%20getting%20paid.md) 49 | 50 | - [Productivity, writer's block, and everything in between](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Productivity%20and%20everythin%20in%20between.md) 51 | 52 | - [Speaking at Technical Writing communities and conferences](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Learning%20Resources/Speak.md) 53 | 54 | - [Technical writing Roadmaps by Hackmamba ](https://roadmap.sh/technical-writer) 55 | 56 | ### Technical writing boot camp 57 | 58 | - Getting started slides from [Empower Her Community in collaboration with Non-Tech in Tech Bootcamp July/August 2022 ](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Empower%20Her%20X%20Non%20Tech%20in%20Tech.md) 59 | 60 | - [Technical writing slides](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Learning%20Resources/Technical%20writing%20slides.md) 61 | 62 | - [Tech: Write & Earn with David Herbert & Sokaribo Senibo](https://startuptrybe.trainercentralsite.com/course/techwriteearn#/home) 63 | 64 | ### Getting paid 65 | 66 | - [Paid Community Writer Programs](https://github.com/malgamves/CommunityWriterPrograms) 67 | 68 | - [Who Pays Technical Writers?](https://whopaystechnicalwriters.com/?) 69 | 70 | - [ContentWritingJobs.com by Tom](https://contentwritingjobs.com/) 71 | 72 | - [Write the Docs Job Board](https://jobs.writethedocs.org/) 73 | 74 | - [Remotive](https://remotive.com/) 75 | 76 | - [Startup.jobs](https://startup.jobs/) 77 | 78 | - [Vultr Creator Program](https://docs.vultr.com/platform/vultr-creator-program) 79 | 80 | - [Draft.dev](https://github.com/draftdev/jobs) 81 | 82 | - [Draft.dev DevRel career](https://devrelcareers.com/) 83 | 84 | - [Blockchain and Crypto Writing Jobs](https://cryptojobslist.com/writer) 85 | 86 | - [WorkingInContent.com](https://workingincontent.com/) 87 | 88 | - [UX Content Collective](https://jobs.uxcontent.com/) 89 | 90 | - [Kaitlyn Alford's freelancer newsletter](https://www.buymeacoffee.com/kmarford/posts) 91 | 92 | - [CSS-tricks](https://css-tricks.com/guest-writing-for-css-tricks/) 93 | 94 | - [ContentLab](https://contentlab.com/writeforus/) 95 | 96 | - [Giskard](https://www.giskard.ai/write-for-the-community) 97 | 98 | - [Who Pays Technical Writers](https://whopaystechnicalwriters.com/) 99 | 100 | - [LWN](https://lwn.net/op/AuthorGuide.lwn) 101 | 102 | - [Freedomwithwriting: Writing contest](https://www.freedomwithwriting.com/freedom/) 103 | 104 | - [Freelance Opportunities!](https://freelanceopportunities.beehiiv.com/) 105 | 106 | ### Technical Writing Communities 107 | 108 | *“Alone, we can do so little; together, we can do so much” – Helen Keller* 109 | 110 | - [Let's Talk Technical Writing](https://twitter.com/writefortech): Bi-weekly Twitter spaces about Technical writing 111 | 112 | - [Hackmamba Creator by William](https://discord.gg/vaajZHh2) 113 | 114 | - Devwrites Africa. To join, send a DM to [Collins](https://twitter.com/codev206) or [Benny](https://twitter.com/Bennykillua). 115 | 116 | - [Write the Docs](https://www.writethedocs.org/): The largest and a global community of people who care about documentation. Join the [slack](https://www.writethedocs.org/slack/) 117 | - [Write the Docs Nigeria](https://www.meetup.com/write-the-docs-nigeria/) [Twitter](https://twitter.com/NgDocs) 118 | - [Write the Docs Kenya](https://www.meetup.com/wtd-kenya/) [Twitter](https://mobile.twitter.com/wtd_kenya). [event page](https://docs.google.com/spreadsheets/d/1Hzygi9izMrQyL_EYWV5puf2hCK65cClsd3pacrFq61A/edit#gid=0) 119 | - Find Write the Docs Meetups in your local community [here](https://www.writethedocs.org/meetups/index.html) 120 | 121 | - [Non Tech in Tech: Technical Writing Clan](https://twitter.com/Nontech_it?ref_src=twsrc%5Egoogle%7Ctwcamp%5Eserp%7Ctwgr%5Eauthor). Join the slack group [here](https://join.slack.com/t/nontechintech/shared_invite/zt-1elj2fo4m-mi0HWRhkC5R8jjkxw73ikg) 122 | 123 | - [UX writing: Content + UX](https://contentandux.org/) 124 | 125 | - [THE UX WRITING LIBRARY](https://www.uxwritinglibrary.com/communities) 126 | 127 | - [Content Strategy](https://community.content-strategy.com/) 128 | 129 | ### Share knowledge and speak at Technical Writing communities and conferences 130 | 131 | To learn more about speaking, check out the [talk, conference, and speaking page](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Learning%20Resources/Speak.md) 132 | 133 | ## Need to contact someone? 134 | 135 | You can reach out to me (Benny Ifeanyi) on [Twitter](https://twitter.com/Bennykillua) 136 | 137 | The GitHub Octodex images used in this repo were gotten from the [official website](https://octodex.github.com/) 138 | 139 | We would greatly appreciate a Star if you like our project ⭐ 140 | -------------------------------------------------------------------------------- /Repo-Images/YouTube timetsamp_Making contributions via GitHub.txt: -------------------------------------------------------------------------------- 1 | 0:00 Accessing the repo 2 | 3 | 1:45 Forking a repo 4 | 5 | 2:58 A Walkthrough 6 | 7 | 06:12 Making your first GitHub contribution 8 | 9 | 10:39 Creating a Pull Request 10 | 11 | 12:23 Merging a Pull Request 12 | 13 | 16:11 First time issues with Airbyte Documentation -------------------------------------------------------------------------------- /Repo-Images/fork.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Bennykillua/Getting-started-in-Technical-Writing/ec51d0c0bd1515e52bc0ad9e3ad14e9860417267/Repo-Images/fork.png -------------------------------------------------------------------------------- /Repo-Images/readme.md: -------------------------------------------------------------------------------- 1 | This houses the images and random files used in this repo 2 | -------------------------------------------------------------------------------- /SEO.md: -------------------------------------------------------------------------------- 1 | 2 | # Search engine optimization (SEO) 3 | 4 | Search engine optimization (SEO) is the technique of improving a website's or web page's visibility in a search engine's unpaid and organic results. 5 | 6 | 7 | ## Resources 8 | 9 | - [SEO – HOW TO RANK UP IN SEARCH. (MAKE THE MOST OUT OF SEARCH ENGINE OPTIMIZATION) by Blessing Ene Anyebe](https://medium.com/@anyebeblessing737/seo-how-to-rank-up-in-search-make-the-most-out-of-search-engine-optimisation-e862bc56adf4) 10 | - [Google Search Engine Optimization (SEO) Starter Guide](https://developers.google.com/search/docs/beginner/seo-starter-guide) 11 | - [Canonical tags: Handling duplicates of contents on URLs by Alemoh Rapheal Baja](https://alemsbaja.hashnode.dev/canonical-tags-handling-duplicates-of-contents-on-urls) 12 | - [Writing for Hashnode - SEO Handbook](https://web3.hashnode.com/seo-handbook) 13 | - [SEO for Beginners: An Introduction to SEO Basics](https://www.searchenginejournal.com/seo-guide/) 14 | - [The Beginner's Guide to SEO: Rankings and traffic through search engine optimization](https://moz.com/beginners-guide-to-seo) 15 | - 16 | 17 | -------------------------------------------------------------------------------- /Technical Writing Courses.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | # Technical Writing and documentation Courses 4 | 5 | Listed below is a curration of courses you can take. Looking for blog post and resource related to techncial writing? check [here](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Technical%20Writing%20Resources.md) 6 | 7 | For tutor-based videos check out these [beginner friendly videos](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Learning%20Resources/Technical%20writing%20slides.md). 8 | 9 | - [Google Technical Writing Courses](https://developers.google.com/tech-writing) 10 | 11 | - [Technical writing mentorship program](https://technicalwritingmp.com/docs/technicalwritingcourse/authors/) 12 | 13 | - [Gitlab Technical Writing Fundamentals](https://about.gitlab.com/handbook/engineering/ux/technical-writing/fundamentals/) 14 | 15 | - [Documenting APIs: A guide for technical writers and engineers](https://idratherbewriting.com/learnapidoc/) 16 | - [Introduction to REST APIs: Video recordings of API doc workshops by Raleigh](https://idratherbewriting.com/learnapidoc/docapis_course_videos.html#video-2-raleigh-workshop) 17 | 18 | - [Docs for Developers: An Engineer’s Field Guide to Technical Writing 1st ed. Edition by Jared Bhatti (Author), Zachary Sarah Corleissen](https://www.amazon.com/dp/1484272161/ref=cm_sw_r_awdo_navT_g_SV4HMY0QJNCGSEZ96T21) 19 | 20 | - [Technical Writer HQ](https://technicalwriter.teachable.com/p/home?referral_code=6TJ7SI) 21 | 22 | - [API Documentation for Developers by Shalvah](https://apidocsfordevs.com/) 23 | 24 | - [Readthedocs Writing Documentation](https://docs-guide.readthedocs.io/en/latest/writing/) 25 | - [Tech: Write & Earn: A comprehensive hands-on workshop to help you get started as a technical writer. by David Herbert and Sokaribo Senibo](https://learn.startuptrybe.org/course/techwriteearn?previouspage=home&isenrolled=no) 26 | -------------------------------------------------------------------------------- /Technical Writing Resources.md: -------------------------------------------------------------------------------- 1 | 2 | # Technical Writing Resources 3 | 4 | A curration of learning resources; articles, videos, and much more. 5 | 6 | Here are a few [Technical Writing courses](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Technical%20Writing%20Courses.md) and 7 | [Slides (quick and short) ](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Learning%20Resources/Technical%20writing%20slides.md) to help you get started. 8 | 9 | Watch some [beginner friendly videos](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Learning%20Resources/Technical%20writing%20slides.md) on technical writing. 10 | 11 | 12 | # Technical Writing Blogs 13 | 14 | You should follow these blogs: 15 | 16 | - [I'd Rather Be Writing](https://idratherbewriting.com/) by Tom Johnson [Linkedin](https://www.linkedin.com/in/tomjoht/) [Twitter](https://twitter.com/tomjohnson) 17 | 18 | - [Write the Docs community: Documentation Guide](https://www.writethedocs.org/guide/) 19 | 20 | - [Kesi Parker](https://medium.com/@kesiparker) by Kesi Parker [Linkedin](https://www.linkedin.com/in/kesi-parker-a86b0a202/) 21 | 22 | - [DRAFT.DEV Blog](https://draft.dev/learn/) by Karl Hughes [Linkedin](https://www.linkedin.com/in/karllhughes/) [Twitter](https://twitter.com/KarlLHughes?ref_src=twsrc%5Egoogle%7Ctwcamp%5Eserp%7Ctwgr%5Eauthor) 23 | 24 | - [Everything Technical Writing](https://www.everythingtechnicalwriting.com/) by Linda Ikechukwu [Linkedin](https://www.linkedin.com/in/linda-ikechukwu/) [Twitter](https://twitter.com/_MsLinda) 25 | 26 | - [APIS YOU WON'T HATE](https://apisyouwonthate.com/) 27 | 28 | - [This is important by Sarah Moir](https://thisisimportant.net/) 29 | 30 | - [Zaycodes](https://zaycodes.com/technical-writing/) 31 | 32 | - [Hey, I'm Dachary Carey](https://dacharycarey.com/) 33 | 34 | - [passo.uno by Fabrizio Ferri Benedetti](https://passo.uno/) 35 | 36 | # Technical Writing Roadmap 37 | 38 | - [Technical writing Roadmap by Hackmamba ](https://roadmap.sh/technical-writer) 39 | 40 | # Technical Writing Books 41 | 42 | - [Docs for Developers: An Engineer’s Field Guide to Technical Writing 1st ed. Edition 43 | by Jared Bhatti (Author), Zachary Sarah Corleissen (Contributor), Jen Lambourne (Contributor), David Nunez (Contributor), Heidi Waterhouse (Contributor)](https://www.amazon.com/Docs-Developers-Engineers-Technical-Writing/dp/1484272161) 44 | 45 | - [Writing for Software Developers by Philip Kiely](https://philipkiely.com/wfsd/) 46 | 47 | # Community resources 48 | 49 | - [Write the doc Kenya](https://drive.google.com/drive/folders/1Nnvz3Qj2bHu0bw4zbivsXAlDkD9cjDmt) 50 | 51 | - [technical-writing-template by Bolaji Ayodeji](https://github.com/BolajiAyodeji/technical-writing-template) 52 | 53 | # Outlines 54 | 55 | - [Outline example by Benny Ifeanyi Iheagwara](https://docs.google.com/document/d/17P89X7Cu4-KUCnbLg5KfQmiV2e-yTbf1xQRx54pZ65s/edit?usp=sharing) 56 | 57 | - [Outline example 2 by Ekekenta Clinton Odionyenfe](https://hackmd.io/VhOlBNAPSdO718O20PCcsg). You should also check out [this](https://hackmd.io/a433E5ntT-GbYe3A9lQQHA) 58 | 59 | # Blogs Post 60 | Wanna learn about technical writing? read the articles below or check out the community [slide contribution](https://github.com/Bennykillua/Getting-started-in-Technical-Writing/blob/main/Learning%20Resources/Technical%20writing%20slides.md) 61 | 62 | - [The Evolution of Technical Writing by Tom Johnson](https://idratherbewriting.com/2014/11/07/the-evolution-of-technical-writing/) 63 | - [Learning to code as a technical writer by Fabrizio Ferri Benedetti](https://passo.uno/tech-writer-learn-to-code/) 64 | - [Starting a Career as a Technical Writer by Leslie Hawkins](https://blog.helpdocs.io/starting-a-career-as-a-technical-writer/) 65 | - [Some advice if you're just starting out your technical writing career by Tom Johnson ](https://idratherbewriting.com/blog/career-advice-just-starting-out.html) 66 | - [Everything You Need To Know About Technical Writing by Linda Ikechukwu](https://www.everythingtechnicalwriting.com/the-technical-writing-process/) 67 | - [How I Became A Technical Writer With Cynthia Peter by Linda Ikechukwu](https://www.everythingtechnicalwriting.com/everything-you-need-to-know-about-technical-writing/) 68 | - [My Self Editing Checklist For Technical Writing by Linda Ikechukwu](https://www.everythingtechnicalwriting.com/my-self-editing-checklist-for-technical-writing/) 69 | - [What Is Technical Content Marketing? by Linda Ikechukwu](https://www.everythingtechnicalwriting.com/technical-content-marketing/) 70 | - [The Technical Writing Process: How To Do Technical Writing Like A Pro by Linda Ikechukwu](https://www.everythingtechnicalwriting.com/the-technical-writing-process/) 71 | - [Technical Writing for Engineers by Veronica Stork](https://draft.dev/learn/technical-writing-for-engineers) 72 | - [My Tech Writing Process by Amruta Ranade](https://amrutaranade.com/2018/03/07/my-writing-process/) 73 | - [What do Technical Writers do? (Also, what is Technical Writing?) by Amruta Ranade](https://www.youtube.com/watch?v=biocrCx5T_k) 74 | - [Is Technical Writing the Right Career for You? by Amruta Ranade](https://www.notion.so/Is-Technical-Writing-the-Right-Career-for-You-3085604c58ad453086331cdabf1953c5) 75 | - [Writing great release notes by Jose Luis Zapata De Santiago](https://bufferbuffer.com/writing-great-release-notes/) 76 | 77 | 78 | # Style Guide 79 | A style guide is a piece of documentation which defines the style a technical writer uses while writing. It lays out a set of editorial rules that ensures consistency in your documents. 80 | 81 | ## Resources 82 | 83 | - [How to Write a Style Guide as a Technical Writer: Best practices and what to avoid when developing a guide. by Light Segun Olumide](https://wonexo.hashnode.dev/how-to-write-a-style-guide-as-a-technical-writer) 84 | 85 | - [Microsoft Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/) 86 | - [Google developer documentation style guide](https://developers.google.com/style) 87 | - [Gitlab Documentation Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide/) 88 | - [Gatsby Style Guide](https://www.gatsbyjs.com/contributing/gatsby-style-guide/) 89 | 90 | 91 | 92 | --------------------------------------------------------------------------------