List of Topics

SfC Home > Writing > Technical Writing >

 

Feedback Q&A on Technical Writing

by Ron Kurtus

Readers have sent in a total of 105 comments and questions on Technical Writingissues. They are listed according to date.

You can read them to further your understanding of the subject.



List of next 10 letters

Topic

Title

Country

FM to RoboHelp What is best for online help? USA
 
Salaries Wants ideas on getting work Nigeria.
 
General How i can be a good technical writer? India
 
Skills Needed What is they require experience? Pakistan
 
Salaries Technical writing in the aerospace industry India
 
5 Ways into Writing Interested in aerospace industry USA
 
Indexing in FrameMaker Having problems finding Text Symbols India
 
Skills Needed Not sure about all the tools needed Philippines
 
General Tech Writers should train on Open Source projects USA
 
Skills Needed Wants to get hired in the U.S. USA
 

Next 10

 




First 10 letters


What is best for online help?

Topic: FM to RoboHelp

Question

October 31, 2005

The company I will be writing Help for is deciding whether to use WebWorks or RoboHelp X 5.

Am I better off converting Frame to Word to RoboHelp or converting from Frame to WebWorks help?

Which of these approaches are:

*Easy
*Non-complicated
*Straight-forward
*Direct
*Less time consuming

Also, is it still true that WebWorks help HTML files need to be delivered in the same exact structure and do not constitute one .chm file?

Pardon if some of the assumptions are not true, I have read too much feedback from both sides.

Nandini - USA

8765

Answer

The latest version of FrameMaker has made the process of converting to RoboHelp much easier, but still it is not perfect. I am sure that WebWorks will do the job. RoboHelp is the "industry standard" but it may also be an overkill, depending on the project.

Cost and future use are a big issue here.

Most help is moving to straight HTML. But still, some applications prefer to use a CHM file.

A couple of resources to help in your decisions are:
http://www.winwriters.com/ and http://www.mshelpwiki.com/

Best wishes in your project.

Back to top


Wants ideas on getting work

Topic: Salaries

Question

August 31, 2005

I'm a Mathematics Teacher here in Kano. I have the skills and a degree in Mathematics Education. I can learn fast. What i need now is an offline job I can do, say a technical report that could be sent to me and typed out neatly for who ever needs my service.

Any ideas. If yes please let me know through my e-mail address.

Adedirin - Nigeria.

7956

Answer

The best thing to do is to start close to home. There are a number of websites that list jobs in Nigeria. Many of those jobs are either technical, engineering or Information Technologies. Although you are not applying for those jobs, such companies often need talented people to write reports and other technical documentation.

Send those companies a short cover letter and 1 to 2 page resume' of your skills and experience. You can apply as an employee or as a temporary worker.

Best wishes in getting desired work.

Back to top


How i can be a good technical writer?

Topic: General

Question

August 2, 2005

Dear, sir/madam
How i can be a good technical writer? and what are the tips to becom so? I finished my Bachelors degree in special English as well as my Bachelors degree in Metallurgial Engineering.

thanking you sir

Rajendra - India

7699

Answer

An engineer who has skills in writing is in demand, because many engineers are poor writers. Companies need people who have technical skills and can write material that others will understand. I think you would make more money as an engineer who can write, so I would pursue that path first.

But also, as a second direction, you can look toward being a technical writer for companies that work in metallurgical areas. See our section on technical writing for more tips in that field.

Also see http://www.stc.org/chapter_search.asp to find a chapter of the technical writing association in India. They can give good advise.

Best wishes in your career.

Back to top


What is they require experience?

Topic: Skills Needed

Question

August 1, 2005

Hi
i wanna add if they require the experience
then what to do
and how to prepare for the interview

maria - Pakistan

7680

Answer

If you do not have work experience, you can provide samples of work you have done, such as papers written in school. If they see your writing skills, they may hire you without experience. But note that using slang such as "wanna" will not get you a writing job. Everything you write, whether it is samples of your work or a simple email must have correct spelling and grammar.

Back to top


Technical writing in the aerospace industry

Topic: Salaries

Question

July 5, 2005

hi
i am interested in taking up a career in technical writing in the aerospace industry
can u please let me know the future prospects the growth

and also the number of people working in this field in US

thanks

vinay - India

7456

Answer

You might find information on the number of people in the field from the www.stc.org website. Knowledge of the aerospace industry is important to gain a career in that area. Often engineers do the writing, so you need to have writing skills to be able to take over their efforts.

Back to top


Interested in aerospace industry

Topic: 5 Ways into Writing

Question

June 29, 2005

Hi
i am interested in taking a career in technical writing focusing on Aerospace industry

can you please let me know how many technical writers are there in this field in US.

what will be the future growth and prospects

Thanks
vinay

- USA

7396

Answer

Check the Society for Technical Communication at www.stc.org to find a chapter near your location. You can get much information about opportunities in your area from the STC chapter, as well as the STC website.

Back to top


Having problems finding Text Symbols

Topic: Indexing in FrameMaker

Question

June 29, 2005

i made a new document .then i select the chapter and wrote on it .then as your help guide says -go to view>text symbols .but i didn't find the text symbols on my document.i am using the FM 6.0 version.I am surely getting symbols of p shaped but reverted shaped and not the symbol "T" which is a indication that its a index keyword.

Nidhi - India

7402

Answer

Those instructions were made with an older version of FrameMaker. We will have to update it to the newer version. If Text Symbols is not on the View menu, they may have moved it elsewhere. Perhaps check in the online help to find Text Symbols and help on Indexing.

Back to top


Not sure about all the tools needed

Topic: Skills Needed

Question

June 14, 2005

hm... i it is clear all to me but what is the use of the technical anyway?
what do they do to us?is that the corel draw... , the adobe photoshop,the MS Word and the other softwares mentioned a while ago was the tools needed in technical writing?

mike - Philippines

7259

Answer

Technical writing is writing manuals to explain how to use a product or software, as well as manuals for training. Often illustrations are needed. Companies may want to use specific software that they own.

So a number of skills are needed to produce these manuals. If they are to be distributed over the Internet, web design skills are also needed.

Back to top


Tech Writers should train on Open Source projects

Topic: General

Question

May 19, 2005

Tech Writers should train on Open Source projects

Here's an idea that I think would work out well. Why don't we get colleges who are training tech writers together with the open source community and have them work together?

The problem as you know is that a lot of open source software is great - but the documentation and user interfaces suck. That's because people are doing this work for free and the documentation and program polishing isn't as much fun as new features are.

These writers in training can be assigned open source projects and work with the developers to create good documentation. It would be part of their training requirements to take the project to documentation perfection. This would not only involve writing the docs - but also working with the developers to request better screen prompts and features that make sense. Often the developers don't understand what the end user needs. And the developer never had to actually learn the software.

Additionally the student(s) could conduct software usability tests where they round up a bunch of new users and sit them down in front of computers and watch them learn the software, encouraging them to verbalize their struggles and frustrations as they work. Additionally students would also moderate tech support message boards and interact with end users who are struggling for answers so that they can fully understand the problems people are having implementing the software. This feedback is then used to correct the documentation and polish the software till it gets to the point that new users say, "This is great - it just works!"

After a student takes a project to the "It just works!" stage they are ready for the job market with the open source project as part of their resume and a reputation already developed. These people would be instantly employable having real world experiences and accomplishments to show. And - they would be developing a broader skill set than just a writing class would teach. They would learn how to interact with developers and end users on a personal level and develop the real world skills needed for getting real work done in the real world.

And of course - the developers get a big boost too in that someone else - a professional writer - does the documentation and assists the developers in ways that they might otherwise miss. This frees the developers to develop and to be creative knowing that the grunt work is taken care of. Their software will be more accepted and more widely used because it just works which will attract donations, other developers, and a community around their project. And good free open source software saves many hours of time which benefits everyone in the long run.

Even proprietary software vendors get a boost in that they can hire these writers right out of school and they are ready to be productive from day one. This makes them more profitable because good writers who can work with developers to get the product perfected allows support staff to be cut. If the software "Just Works" then you don't need a lot of people to support it.

This is an idea where everyone wins and it makes me wonder what someone has to do to make it happen.

marc - USA

7024

Answer

Thanks for sharing your idea. One problem is that colleges often don't want to go away from mainstream methods. So they probably would not cooperate in such an idea.

A solution is that many cities are trying to encourage high-tech startups, like those devleoping open source software. They may set up an intern program to have college writers help with the documentation and such.

You might suggest your idea to the Society for Technical Communication (STC). Their magazine is the Intercom and they might be interested in your views. See the online version at http://www.stc.org/intercom/

Contact them with your ideas at: intercom@stc.org

I like your idea. Perhaps it will go somewhere. Best wishes with your efforts.

Back to top


Wants to get hired in the U.S.

Topic: Skills Needed

Question

May 5, 2005

Hi,
I came US on H4 and presently in the US to accompany my husband. I am a post grad in Computer science and with Microsoft certification with .NET(MCSD) and expe or 5 in this field.Since I am here on an H4 visa, I am not permitted to work in the US. So I would require the company that hires me on H4 and give tempararily work and to sponsor an H1 visa for me.

I would appreciate any helpful suggestions / advice from your side.
Thanks,

Kirti - USA

6881

Answer

I assume your husband has a job here. You might check to see if there is any work you could do with the company for which he works.

Another possibility is to find a company that has an office in your native country. They may be interested in helping you.

You may be able to get temporary work with some small consulting firms.

It is not easy, so you will have to try as much as you can. Best wishes in your efforts.

Back to top

Next 10


Summary

Hopefully, this reader feedback has helped provide information about Technical Writing issues.


Write well


Resources and references

The following are some resources on this topic.

Websites

Technical Writing Resources

Books

Top-rated books on Technical Writing


Questions and comments

Do you have any questions, comments, or opinions on this subject? If so, send an email with your feedback. I will try to get back to you as soon as possible.


Where are you now?

School for Champions

Technical Writing topics

Feedback Q&A on Technical Writing




Technical Writing topics

Getting work as a Technical Writer

Developing technical documentation

Using tools

Success requirements

Also see



Let's make the world a better place

Be the best that you can be.

Use your knowledge and skills to help others succeed.

Don't be wasteful; protect our environment.

You CAN influence the world.





Live Your Life as a Champion:

Take care of your health

Seek knowledge and gain skills

Do excellent work

Be valuable to others

Have utmost character

Be a Champion!



The School for Champions helps you become the type of person who can be called a Champion.