Quick Editing Guide for Technical Writer

Documentation is like sex; when it’s good, it’s very, very good, and when it’s bad, it’s better than nothing. – Dick Brandon

Technical documents such as User Guide, Configuration Guide, Installation Manual and others must be written in such a way that these translate the complex and puzzling into something that everyone and anyone can understand. When the user reads the user guide, it must obviously guide him and should not confuse him. The step-by-step guide must be clearly stated and logically arranged.

Continue reading

Advertisements

Footnote to aspiring Technical Writer

Writing skills and technical knowledge form the foundation of technical writing career. One do not need to be a software developer to become a successful technical writer (in IT). He only needs to understand what the developers do.

Although some companies prefer to get a very “technical” writer – those with technical degree – many companies have apprehensions that “technical” writer will soon get more interested on coding rather than writing/developing online help systems, designing web sites, and delivering multimedia training.

Continue reading