Technical Writing at Empower Her Community.

Technical Writing at Empower Her Community.

Table Of Contents

  • Empower Her Community and Non Tech In Tech

  • Technology of Technical Writing

  • Stumbling Blocks

  • Author's Guide

Empower Her Community and Non Tech in Tech (EHC X NTIT)

logo3.png

The Empower Her Community is a tech-based community focused on training and promoting women in the field of Information Technology.

It’s mission is to make Information Technology accessible to all women with no discrimination by providing opportunities for women to be incorporated into the industry and have an easy transition regardless of your background. EHC teaches women through Webinars and Boot-camps some technical skills such as: Digital Marketing, Web Development Graphics Design , Data Science, 3D Design, ui/ux Modeling, Printing and many more. The most juicy part is that EHC is a non-profit organization with zero payments for the knowledge and service you’re getting.

15.jpg
10.jpg

I was privileged to attend the just-concluded Non tech boot camp. The very first non tech boot camp at EHC in collaboration with non tech in tech NTIT with skills set for; product manager, technical writer , community management, ux writing , product marketing, growth marketing and digital marketing.

The whole world is raving about Information Technology because of its major changes in the world. Through Technology, new forms and pattern of work has been created leading to wider societal changes, improvement and advancement in economy, health, agriculture, finance, business and so much more.

To ensure technology develops to meet the needs of the public, the sophisticated growth has encouraged software developers, computer scientists, computer network specialist, computer programming, IT project managers, web developers, cyber security, data analysis etc.

At a glance, the many aspects of information technology can be a bit overwhelming especially to those who have never had any prior experience or background in tech. I fell under this category and I knew I wanted to go into Information Technology but I just didn’t know how to go about it.

EHC in collaboration with Non Tech in Tech organized a non tech Boot Camp. The idea was to encourage those that want to start their journey into tech but don’t want to face the whole coding and software drama all at once. A different niche that doesn’t require much coding but plays a vital role in information technology was made available.

The opportunity came for the boot camp and I saw technical writing. The “writing “ caught my attention because I have a background in writing and have done a little writing here and there and the opportunity here was writing in tech.

IMG_6230.jpg

I jumped at the opportunity, did my screening exercise and got accepted after meeting the basic requirements. Here I was with little writing skill and no prior knowledge in tech starting a new technical journey. I had doubts, felt intimidated and scared at some point. I had uncertainties as I tried to fit it, I asked myself how was I going to fit in and all.

To shut down the voices in my head, I made the decision to take things one step at a time and the first step I decided to take was going into tech through technical writing.

Another key important thing I did was to believe in myself and with the help of my amazing facilitators Mary Sule and tutors in the likes of; Light, Timonwa Akintokan, Blessing Ene Anyebe, Benny Ifeanyi who are experts in the field of technical writing who passed their knowledge. Through baby steps I was introduced to technical writing and as i progressed, I took giant strides.

The Technology Of Technical Writing

Technical Writing is a type of writing where the author or writer picks a particular topic and simplify the complex technical terms into simpler terms for easy understanding by user.

lilartsy-jw3xbuelpKM-unsplash.jpg

Why do we write?

Technical writers write for the following reasons ;

• To simplify complex technical terms

• Share knowledge

• Provide solutions to problems

• For documentation.

Different Types of Documentation

Listed below are some examples of documentation;

  1. User Guide Manual: It provides a step-by-step manual which includes application use, product description, do’s and don’ts, assemble instructions etc.

  2. White Paper: It is a authoritative guide or report that explains the benefits of the solution a product/service does

  3. Application Programming Software (API): It is a software interface that allows two or more programs to communicate with each other.

  4. Software Development Kit (SDK): It is a set of programs and software tools that provide the developer with ability to build specific applications/apps which can be added to another program

  5. Policies and Procedures: These documents include polices and guidelines that help protect the company against lawsuits from issues that arise. They also include application of government policies and guidelines.

Skills to have as a technical writer

To be a technical writer there are basic skills you must have to succeed and pass information clearly.

• Use of English: It is important you have the basic knowledge of English, correct use of grammar, correct spelling and when to use passive or active voice.

• Ability to Write: The only way to know how to write is to write. Set writing goals, write consistently. writing consistently is the only way to master your writing and get better

• Research : The importance of research can never be over emphasized. In technical writing you need to have enough knowledge and understanding of what you intend to write on. Make research, know your audience, put yourself in your readers' shoes ask yourself possible questions and provide the answers for for user.

• Know how to put your thoughts clearly on paper: As a technical writer, you need to know how to pass your message in simple plain terms. Be concise, straight to the point and don’t drag the topic

• Develop a technical skill: Some people become technical writers to document their programming, engineering and computer journey while others join technical writing without having any prior tech skill. As much as being a technical writer without any tech skill is still accepted most of the time it helps when you have an additional knowledge to it and it helps you have a particular domain to specialize in, which helps you develop a unique style.

Technical Writing Tools.

There are several writing tools that assist the writer in his work. Some of these tools include;

1.Research tools: Research tools help the writer in gathering data and research

  • Google and Wikipedia books
  • Survey forms
  • Quora

2.Note Taking Tools: Note taking helps you store data to make reference easier. Examples include;

  • Google docs
  • Evernote
  • Default note apps for laptop and phone

3.Media Tools : It is used for creating and editing images, screenshots, videos and any thing visuals.

  • Canva
  • Unsplash
  • Adobe after effect
  • Sketch.

4.Editing Tools: They help to correct your sentences, spellings, check your grammar and also check for plagiarism.

  • Grammarly
  • Quilbot
  • Hemingway editor.

5.Publishing Tool: There are places for you to post your work. You can publish on your own personal blog , contributing blog, personal website. Example ;

6.Authoring Tools: Author tools help you write and create written contents using text media. Examples include

  • Google docs
  • Evertone
  • Markdownpad
  • Google keep.

7.Search Engine Operation (SEO): SEO’s are used to optimize one’s content with the primary aim of ranking top in search engines. It helps users find their work easier. You optimize your key word to drive more traffic to your page .

8.Open Source: The common misconception about open source is that open source is limited to only people who can code but this isn’t true. With open source you’re allowed free access to the source code and you’re able to modify however you desire.

Stumbling Blocks

Nothing good comes so easy in life; at one point or another we are bound to face difficulty and challenges. They come in different forms; we have the ones created by our surrounding circumstances and ourselves which may be as a result of our mindset but that is what makes us human and as humans we’re flawed. In the course of the boot camp, I had few challenges here and there, some are stated below;

  1. Procrastination : As the saying goes

istockphoto-545810542-612x612.jpg

“The greatest thief this world has created is procrastination and he’s still at large”.

We often procrastinate when we are faced with difficult situations, tiring or boring tasks. Which ever it was, I was a procrastinator. So many times I told myself > " I will do it later".

Later turned to hours, days and even weeks and the work piled up for me and it wasn’t the most pleasing experience.

  1. Doubt and fear : Many times I doubted myself. I wasn’t sure if I had what it took to become a professional technical writer. I developed cold feet each time I did research about technical writing and I saw so many writers out there. I asked myself what special thing do I have that will make me stand out from the crowd? Most times, I didn’t have an answer

  2. Outdoing myself: Many times, we believe that we should be able to stretch ourselves to expand more and do more but that isn’t always the case. Some points where I felt I wasn’t doing enough, I wasn’t putting in enough efforts and therefore no much output and this stressed me out a lot. I ended up having writer's block whenever I outdid myself.

  3. Not having an accountability partner: An accountability partner is someone who guides and motivates you to achieve your goals and set target. An accountability partner helps you remain committed and checks your progress. Well, I didn’t have that and so there was nobody to put me in check except my project deadlines marked on my calendar.

  4. No technical skill: Prior to this boot camp I had no technical skill whatsoever and at some point I felt off track. Having a technical skill such as software engineering, UI/UX, front-end engineering looked like it made the work easier because you already have a domain you could niche down to and specialize in your area of strength. This felt like and added advantage, one which I didn’t have. So, navigating through the new terrain wasn’t easy especially with no experience whatsoever.

Author’s note:

After outlining and identifying my flaws, I had to figure out how to wiggle myself away from that position.

Here are some tips you can adopt whenever the going gets tough and you feel like giving up or feel you are not good enough.

  1. Breath: Leave your desk and take a walk out of your work space. Find a comfortable position which can either be standing, sitting or lying down. Take a deep breath in, now let it out. You may notice a difference in how you feel already. Your breathing is a powerful tool to ease stress and anxiety. This simple breathing exercises can make a big difference if you make them part of your routine whenever you feel stressed or over worked.

  2. Believe in yourself : Your mindset can either make or mar you. The state of your mind reflects in your writing. You are your biggest cheerleader. Believe in yourself no matter the problem or circumstance. Always have a winner's mindset and be the best version of yourself.

  3. Make a decision to do better: Every decision we make produces an outcome. Make the right decisions on time and clear the path ahead for smooth sailing. Let go of that bad habit that keeps limiting you. Stop procrastination and discipline yourself.

  4. Plan:

2h-media-cdDDWLezAJ0-unsplash.jpg Planning makes your writing much easier and also helps for smooth sailing.

-Have a monthly, weekly and daily to-do lists . -Set out time to research and study -Mark your calendar and have trackers -Create a reward system for yourself

  1. Keep writing and keep practicing:

Not everyone is born with the gift of writing. Many master the act of writing from constant practice and writing. The more you write, the more ideas and inspiration come. The solution to your writer's block is to pick up your pen and write until something comes out.

  1. Join a community and have an accountability partner:

3.jpgEmpowerhercommunity

Having an accountability partner enables you to always be on track. You can source for your own accountability partner or get one from the community group you join. Remember that sometimes two heads are better than one and it helps when you are in the same field. Also, note that you can also have study groups which also help keep you on track.

Examples of communities you can join:

EmpowerHerCommunity.com

Writethedocs.com

Hashnode.com

Freecodecamp.org

Medium.org

You can also search for communities on twitter.

Good luck!!! hannah-grace-j9JoYpaJH3A-unsplash.jpg