Technical writing in software companies

Often it is found that software companies are not able to define their requirements for the job of technical writer. They give an advertisement in the local newspaper or an online job portal and specify just good English as the main requirement of the job. But I think there is more into it. An ideal technical writer should have an interest and understanding of technology.

The job of technical writing in software companies is two-fold:

1. Preparing software documentation : It involves rigorous consultation with the software developer. The objective is to help any other technical expert to understand the syntax and logic of the program using flow charts, data flow diagrams, etc. Here is where your technical knowhow come into play.

2. Preparing user manuals : It involves writing online guides, help files, installation guides. It is to be written in simple English avoiding any computer jargon. It is like explaining the how-to and applications of your product to a layman. Here is where your English language skills come into play. A wrong grammar may completely change the meaning of any sentence. So correct grammar is very important.

So. in my opinion, software companies should hire technical writers with the following skill set and qualities:

Good written English with correct English grammar and sentence construct.

Knowledge of SDLC, programming languages, programming logic.

Ability to create E-R diagrams,flowcharts, use cases, data flow diagrams, etc.

Excellent communication skills to interact with the software developers.

Knowledge of documentation(writing) tools.