Techincal Writing Archives

Published: 3 August 2022

Tags: ITCQF, Techincal Writing, technical communication

Today, it is becoming more important to become a qualified technical writer.

More than 75% of technical writers worldwide have moved into technical writing as a pivot. Career changers bring their expertise in many different fields to their new careers in technical communication . They use their qualifications from other industries to broaden their vision and understanding of the role. As most technical writers have different professional backgrounds, they often lack any degree in Technical Communication and instead have a certificate from a local training facility.

Pivoting into TechComm

Jordan has a BSc in computer science and a background in software development. He moved to Israel recently and decided that he wanted to change his career. Combining his love for technology and for writing in English, he decided that technical communication was the answer. He completed his courses at an online training facility and received a certificate as a technical communicator. He quickly found a position and his career has grown along with his knowledge. He is now a sought-after candidate for technical writing positions in Israel’s dynamic hi-tech market.

Becoming a Qualified Technical Writer

Olivia was a freelance translator who was looking for better job security. She found an internship program, took some classes, and started her career in Technical Communication. For Olivia, an internship gave her the experience, while the courses gave her additional practice. The mentors that Olivia worked with hired her to work as a junior technical writer and a few years later, she was promoted to a senior writer’s job. Shedecided after a few years to become an independent contractor and to take advantage of the “gig economy” during the pandemic. She took a class to get certified in technical communication so that her experience could be ratified by international authority and give companies across the EU a reason to consider her. Today, she has clients knocking on her door and feels that her training and certification, in combination with her experience, gives her a big advantage over the competition.

Investing in Professional Development

Tania has a BA in journalism and media and decided to take a training program in technical communication to give her additional advantage in the job market. For the past 8 years, she has worked as a technical writer for a start-up ad-tech company. Tania was worried her skills would start to stagnate if she didn’t invest in her personal development. She wasn’t sure how much longer the start-up would last. She wanted to make sure that, if something happened to the company, she would be ready to enter the job market as a desirable candidate. So, Tania took some additional classes and also decided to certify in Technical Communications. When her company decided to close, thanks to her new skills and experience, Tania quickly had several relevant offers from large companies.

Jordan, Olivia and Tania have one thing in common. All of them are certified in technical communications by ITCQF, the International Technical Communication Qualification Foundation.

What is ITCQF?

ITCQF, the International Technical Communication Qualification Foundation, is a non-profit organization committed to professionalizing the industry by certifying technical writers all over the world. They have set an international standard for technical writing, just as the International Software Testing Qualifications Board ISTQB does for QA professionals and IEEE does for engineers. Their examinations are set and monitored by the GASQ.

The ITCQF certification never expires and is recognized all over the world. ITCQF training centers provide courses to prepare their students for the certification exam. All training sessions are delivered by instructors who are ITCQF accredited.

ITCQF certified professionals can be found working in leading companies around the globe, including: Google, Motorola Solutions, Siemens, and Atlassian. Once you become part of this elite network, you will have many more colleagues you can collaborate with, and who can provide you with work opportunities.

Why should I get certified in Technical Communications?

The ITCQF certification is an internationally known and accepted certificate administered by the GASQ. Their standards are set by leaders in technical communication and their certificate never needs to be renewed. This certificate qualifies you for the job title of technical writer and gives you formal proof that you have been taught the necessary skills for the profession. An international certificate will give you international recognition in the job market, and employers will turn to you over other non-certified candidates. As more certified individuals enter the job market, certification will become a requirement. Having it now puts you at an advantage among an elite group of individuals who have decided to achieve international recognition for themselves in the technical communication profession.

Today, many companies are looking for qualified technical writers. You can open the door to higher-paid opportunities with a certificate from the ITCQF. Walk into that interview with confidence in your skills and something more to talk about. Internationally, certification is going to become a requirement for the job, so it is only a matter of time before this becomes a requirement in Israel’s competitive market. Don’t be the last person to invest in your own career development!

Where can I take an ITCQF course?

There are ITCQF training centers in 12 countries including the US, Australia, the UK, India, and across Europe. Companies often have technical writers scattered between their workspaces, so they have training facilities for this certification path in multiple locations, which makes getting certified easier than ever. This international certification program is now available online from Israel, with live online courses open to anyone anywhere in the world for whom the synchronous evening classes are convenient.

Our Best Words, the only accredited training organization for the ITCQF in Israel, is leading the way to training technical writers to become qualified and certified. The Our Best Words online training program teaches you everything you need to know to pass the certification exam. The ITCQF course can be taken by experienced techcomm professionals as a stand-alone course, or at the end of of our flagship Technical Communications Foundations training program.

What are you waiting for?

Becoming a qualified technical writer is the easiest way to set yourself apart from the competition. The ITCQF certification program provides the most advantages since it meets industry-wide standards. If you aspire to break into international markets, you will have many more opportunities through becoming an ITCQF certified technical writer. You will know that your skills and knowledge are backed by a respected international organization. Your employers will be satisfied that their content is safe in your very capable hands. Here in Israel, you will join an elite group of individuals who feel that certification from ITCQF is an essential step in qualifying your skills in a larger arena.

Click here for more information or sign up TODAY for the ITCQF Online Training Course.

Published: 20 July 2021

Tags: Courses, Foundations Program, MarCom, Marketing Writing, Techincal Writing, technical communication

One of the most rewarding jobs for people who move to Israel from English-speaking countries is technical writing. But you don’t have to be a tech geek to become a technical writer!

Israel’s tech industries are always looking for technical writers. But we’re not only talking about hi-tech – today Israeli companies are specializing in bio-tech, green-tech, fin-tech, agri-tech, and canna-tech (cannabis research and production) are all growing fields!

You might think that you have to have a technical background to become a technical writer, but that’s not true. One of Our Best Words’ most successful recent graduates, Avi Chazen, used to work in tourism and is now a technical communicator for a global software company.

“I was looking to pivot out of tourism even before COVID because I enjoy learning new things”, says Avi. “It turns out that being a good communicator gave me an advantage as a writer, because I am good at communicating freely with developers to understand what needs to be documented. To become a technical writer, you don’t need a technical degree. You just have to be technically competent, organized, and a good communicator. If you can take complicated information, understand it, and make it accessible to others, you can work in technical communications.”

What do Technical Writers Do?

You can work in-house for one company as a technical writer, information developer, or documentation manager, or you can work as a freelance technical writer for multiple companies. Your main work would be writing user guides and release notes for technical products. You need to think like a user in order to translate the developer’s jargon into simpler language. Technical communication professionals may also help with designing the user interface for products.

Our Best Words observed a trend among hi-tech start-ups who want people who can not only write their technical documentation but also their internal documentation, and their marketing materials, such as white papers.

STOP PRESS: The free trial class at our next Open House. Click here to sign up!

Israeli companies, in particular, may even ask their English-speaking technical writers to write their promotional campaigns and run their social media campaigns. If you can offer MarCom expertise alongside your TechComm skills, this will help to bump up your salary! (That’s why Our Best Words offers a combined course in Technical Writing & MarCom)

How Can I Learn Technical Communication?

The good news is that you don’t need to go back to school to become a technical writer. Our Best Words offers a 5-month course taught in the evenings, so that people who are working during the day can participate.

Our Technical Communication Foundations course runs over 16 weeks, with classes on Tuesdays and a follow-up Lab or discussion session on the following Monday. This course is taught by our Principal Technical Communication Lecturer Leah Guren, who is a Fellow of the STC (Society for Technical Communication) and a founding member of Tekom Israel.

Also on the TechComm team at Our Best Words are FE King and Laura Novich, two highly experienced technical writers and ITCQF Certified Instructors, who sit on the International Technical Communication Qualifications Foundation Board and prepare our students for ITCQF certification. Laura teaches Advanced Technical Writing Skills and Technology for Software TCs. She also helps our students to find internship projects (such as GitHub) and paid employment.

How much could I earn as a Technical Writer?

Our Best Words invests enormous efforts to find work for all of our course graduates. We not only run workshops on how to find work, and help students to optimize their resumes and LinkedIn profiles, but we also look out for opportunities for them in Israel’s dynamic tech markets, and leverage our contacts to get them interviews with good companies.

Some of our 2020 graduates are already earning salaries of between 14,000 – 17,000 NIS per month shortly after completing the course. (You can find out more about what technical writers earn from the international 2020 Write the Docs Salary Survey).

So, if you are wondering whether Technical Communication could be a good career move for you, we’re here to answer your questions and help you make the right decision.

Click here to join our Virtual Open House

Published: 28 April 2021

Tags: Advanced Software Documentation, API, Courses, Techincal Writing

Looking back, 2020 was filled with uncertainty and trepidation. Would we be able to open a Technical Communication class at Our Best Words on Zoom? Would Covid-19 allow our students to work and study? How many would lose their jobs? How many would get sick? So many questions, and at the beginning there were very few answers.

As the year progressed, we discovered that not only did we have enough students to teach, but we also had four successful internships and amazing final projects. Our students were challenged intellectually and technically. They learned complex concepts, complicated tools, and how to create workflows and diagrams. In the end, we persevered and rose to the challenge. They all successfully completed their projects and their work speaks for itself.

As a part of my Advanced Software Documentation module, my students learned about open source software and learned how to document APIs. I admit that I was a bit skeptical about bringing something so complicated to my students. API documentation is not for everyone. An Application Program Interface is an interpreter between two devices or endpoints, similar to a waiter who interfaces between the kitchen and the customer. Almost every software company uses APIs or develops them, so understanding how an API works and how to document it would be an advantage for any junior technical writer who is learning the tools of the trade.

If you have never looked at code, it can be quite difficult to really understand and document APIs correctly. I decided to use the open source philosophy and to ask the community for help. I contacted the Write the Docs group and they gave me so many ideas that I wasn’t sure how to use all of them!

Alex Fiedler offered to share his API Documentation Exercise and was always available to answer questions. His exercise was more complicated than I wanted, so I simplified it by restricting the choices, but I didn’t simplify the code. This modified exercise was the final project for the API mini-course, which was part of the larger Advanced Software Documentation course at Our Best Words.

Once I had the content, I decided that the API mini-course was too short to allow me to teach a new API documentation tool such as Swagger or Postman. As the content was going to be hosted on GitHub, I wanted to give my students Markdown templates for writing the docs. The community answered this need as well. The Good Docs Project has templates for many kinds of docs including API documentation. Their templates include a readme which explains how to use each kind of template. It is written in Markdown and hosted on GitHub. Check it out and contribute to making the project better!

Whenever I had a question, the Slack group at Write the Docs was more than ready to help. Special mention to Alyssa Rock and Chris Ward, who were more than helpful in answering questions with patience and care.

So, if you have read this article to the end and are wondering how you can learn to write API documentation, here are some tips:

If you want to learn the course with an instructor, Our Best Words offers a mini-course in API documentation as part of their Advanced Software Documentation course.
If you want to teach yourself, there are some courses which are really good. Tom Johnson has a blog called I’d Rather be Writing.
Learn a bit of JSON, REST, or Python. You don’t need to know how to write a program but you do need to know how to read and analyze one. In the same way that a psychologist learns statistics in order to be able to understand correlations, a technical writer needs to be able to read code snippets and understand what they do.
Showcase your work. Use the static site generator from GitHub to create a website of your docs. If that is not an option, just host it on GitLab or GitHub.

Technical Communication Courses

Laura Novich MSc, Advanced TC Skills Lecturer

Laura Novich entered into technical writing in 1997 and has worked in both startups and fortune 500 companies in diverse fields such as virtualization, cybersecurity, and enterprise cloud solutions on both Windows and Linux platforms. Laura is a regular contributor to “Open Source” magazine, is a founding member of “Write the Docs Israel”, and is highly recognized for her contributions and maintenance to Fedora’s open-source documentation (in KVM). She is a frequent presenter at MEGAComm and has had speaking engagements at the Red Hat KVM forum and has attended several hackathons. Laura has won the prestigious Red Hat EXCeed award for her outstanding collaboration work as well as the 3Com 3Award for her outstanding work in managing the ATM documentation project. In her current role, Laura is building and managing an open-sourced documentation community at ScyllaDB, where developers, customers, and open-source activists can contribute.

Laura’s diverse career history includes educating new immigrants in English (ESL). In this capacity, she was selected to be a curriculum writer for her school district and a teacher trainer for the NY state ESL aptitude test (NYSESLAT).

Laura has a rich set of hobbies and volunteer work, which includes being a mentor for FIRST robotics teams, genealogy, baking, and cake decoration. In addition, Laura is currently documenting her grandfather’s extraordinary life and together with her husband, Jason they manage and maintain a community library with over 2,000 titles.

Laura has both a B.Sc. in psychology an M.Sc. in TESOL and is a licensed English teacher (K-12) in Israel and the USA. Laura is a Red Hat Certified System Administrator.

Published: 14 June 2011

Tags: Techincal Writing, Technical jargon

Technical writers translate complex subjects for users. They change technical jargon and turn it into understandable text for everybody. Regardless of the industry or field of expertise, there are three important tips for writing technical documentation.

Use plain English instead of complex phrases or buzz words

Every industry and market has its own buzz words. “Discussing it offline”, “working around it”, “streamlining operations”, “thinking outside the box”, “impacting the bottom line” belong in marketing materials, not in technical documentation such as user guides and manuals. Especially for tenders and RFPs and RFIs are buzz words and jargon the kiss of death – governmental agencies require that documents are easy to read and understand.

Understand the local lingo

A technical writer must understand the “local lingo” or jargon. For proper technical writing, the writer must fully understand what a certain phrase or term means to a customer and (end) users. Technology companies have the tendency to coin their own definitions. No online research will help the writer; only direct asking the source (content provider, product manager, software developer, etc.).

Recycle and reuse to avoid reinventing the wheel

Technical writing normally deals with similar documents within an organization over time. It is therefore not necessary for a technical writer to start from scratch for each project. Unless it is a nascent start-up, legacy templates, earlier technical writing documents such as reports, proposals, and user manuals are floating around in the organization. It is therefore a lot safer (and easier) to look for templates to tweak or to use as a starting point. For odd projects, there are normally examples that can be used as an outline.

These three tips will help you as a technical writer to be an asset to a team, to contribute user-friendly and customer-specific content that adds additional value to organizations.

Want to learn more about the difference between technical writing and marketing writing? Sign up for one of our courses! Email us at: info@ourbestwords.com

You can also call us at the Our Best Words Main Office: 02-656-3369
US & Canada: 1-786-507-8206

Ephraim King, CEO: 050-529-0775
Tracey Shipley, Marketing Coordinator: 054-810-8918

(Image courtesy of Susana Maria Rosende)

Published: 26 May 2011

Tags: Courses, Internships, Job Opportunities, MarCom, Power Office, Techincal Writing

Immigrants who made Aliyah within the last 10 years could qualify for an 80% scholarship through the Misrad Haklita Voucher Program

Jerusalem – May 19, 2011 – Our Best Words (OBW), a Jerusalem-based company providing technical writing services and training, announced today that it opens its 4^th technical & marketing writing course.

Topics include:

Technical Writing – writing, editing, proofreading, using graphics, online help
Information/Document Development – API, medical, hardware/software documentation
Skills – advanced use of Microsoft Word, Excel, PowerPoint, and Outlook Project and document management
MarCom – marketing, marketing writing, PR, social media

“Since Tzfat is a hub of talented English-speaking professionals, we are opening our 4th course there to help immigrants and veterans start a new career as a technical writer,” said Ephraim King, CEO of Our Best Words. “Our program also includes an internship and assistance with employment placement.”

The course will take place on Thursdays from 9:30 till 18:30 at the Merkaz Tze’irim, 10 HaNasi St. in Tzfat.

Starting 7 July 2011, the 152-hour course consists of 8-hour sessions during 19 weeks.

The price is NIS11,000 (which includes a state-of-the art laptop with a fully licensed copy of MS Office 2010) or NIS 9,000 without a laptop. Additional discounts are available for AACI members.

Want to learn more? Contact us for an interview and placement test at:

Our Best Words Main Office: 02-656-3369
US & Canada: 1-786-507-8206

Ephraim King, CEO: 050-529-0775
Tracey Shipley, Marketing Coordinator: 054-810-8918
Email: info@ourbestwords.com
Website: http://www.technicalwriting.co.il/training/tech-writing-course-tzfat/

About Our Best Words
Our Best Words (OBW) specializes in providing quality technical communications to customers worldwide. The Company enjoys close relationships with a broad range of businesses – from startups to Fortune 500 companies. Offerings include corporate technical documentation, localization, technical communication, and technical marketing services worldwide. The Our Best Words team is comprised of experienced and dedicated professionals with years of experience in technical and marketing communications.
Visit OBS website at: www.ourbestwords.com

Published: 5 May 2011

Tags: History, Techincal Writing

Technical Documentation has been around for several centuries. Especially with the continuous launch and upgrade of technically advanced products and services, user guides and technical descriptions are needed.

Who was the first technical writer? Quite likely Cro-Magnon man when was drawing on his cave walls. However, most experts would agree that technical documentation appeared as early as the 14th century.

Geoffrey Chaucer detailed the purpose and operation of a navigation device. Copernicus, Hippocrates, Newton and Leonardo da Vinci wrote explanatory notes to demonstrate the use of their inventions. All these publications can be seen as technical documentation.

But the golden age of technical writing started with the invention of the computer and the need for mass technical documentation. It started during World War II with the major technological upgrade manufacturing weapons and the creation of nuclear technologies.

Modern day technical documentation is linked to computer science in general and internet in particular. Needless to say, the growth in technology users has sparked the need for technical documentation.

The growth in technical products and services has created the demand for professional documentation. This has created a new profession: technical writing. A good technical writer is an honest mediator between people who create technology and who use technology.

The domain of technical writers has recently expanded to a more interactive (Web 2.0, wikis) one. Technical writing has evolved from pure technical writing into technical communicating.

Want to learn more? Want to join the technical writing evolution? Contact Our Best Words at info@ourbestwords.com or call us at (972) 02-656-3369 or 1-786-507-8206

The ITCQF Certificate: Your Path to a Successful Career in Technical Communication

Today, it is becoming more important to become a qualified technical writer.

Pivoting into TechComm

Becoming a Qualified Technical Writer

Investing in Professional Development

What is ITCQF?

Why should I get certified in Technical Communications?

Where can I take an ITCQF course?

What are you waiting for?

Who can become a Technical Writer?

If You’re API and You Know IT!

Laura Novich MSc, Advanced TC Skills Lecturer

Three Important Tips for Technical Writers

Our Best Words Opens a Technical & Marketing Writing Course in Tzfat on July 7, 2011

A Brief History of Technical Writing

Technical Documentation has been around for several centuries. Especially with the continuous launch and upgrade of technically advanced products and services, user guides and technical descriptions are needed.