Beginner Tips for Technical Writers

-

Beginner Tips for Technical Writers

Grammar and Sentence Construction

  1. Detect Passive sentences and re-write them. 
  2. Check Subject + Verb agreement for sentences and update them if required. 
  3. Use Images only if necessary. 
  4. Write an Overview paragraph for every feature and ensure the paragraph has a logical flow of sentences. 
  5. Learn to write Procedures (step 1, step 2, step 3 etc.) 

Comments

  1. Unknown25 February 2021 at 14:12

    Very useful for freshers. You captured what is exactly required for new joiners.

    ReplyDelete

Post a Comment

Popular posts from this blog

MadCap Flare Training

-
Hello Guys!  MadCap Flare Training : If you are looking for training in MadCap Flare - the popular authoring tool from which you can single-source your documentation and create many outputs like HTML5, PDF, and EPUB, please reach to me at:  roshan.cr@gmail.com   Technical Help on MadCap Flare : If you need urgent technical help like implementing conditions, configuring targets, adding custom code, you can also reach me at: roshan.cr@gmail.com    Thanks, Roshan
Read more

Becoming a Technical Writer in India - Part 1

-
Becoming a Technical Writer In India I became a Technical Writer by some lucky turn of events. After completing Engineering , I was looking for jobs in the software industry , and then I got to know that I can use my existing English / Grammar skills and become a technical writer in the Information Technology (IT) industry . My parents begged me to read The Hindu newspaper daily and at the least read the headings on every page from childhood. Seeing my dad go at it with such enthusiasm daily, I started reading the newspaper to become a good English-speaking person or gain knowledge like him. My dad was known as “the guy” if someone wanted to inquire which course would be good for their son/daughter. So it was “becoming” like him that I started reading the newspaper headings and also to get good at vocabulary. For me, it seemed like Dad could tell the meaning of any word in the newspaper without seeing a dictionary. It surprised me a lot; I used to use the dictionary for every wo...
Read more

Becoming a Technical Writer in India - Part 2

-
(continued from part 1 ) So after learning that I got a job and with an offer letter in-hand, I decided to travel to my hometown. I didn't plan the trip, nor did I book any ticket in advance; I just reached the bus station (dock). There I learned that there are no direct buses to my hometown, then I had to board a bus to the half-way point and then catch a new bus from there to my hometown. I got a bus to the half-way point ( Kurnool ), and it was a muddy route, and the journey was hectic, but I was just on cloud9 that I finally got a job!!! And kept thinking that my mum and dad would be so proud and happy to hear this. I reached Kurnool at midnight, and it was almost the next day; I quickly found the next bus to Tirupathi and boarded it. Again the route was horrible, and I was sitting on the last row of the bus, which meant I was jumping every time a pothole or speed-breaker came :). Cut to the morning, I was home and told my parents, they were happy for me and wanted me to take ...
Read more