TW to develop a guide for new developers

Subject: TW to develop a guide for new developers
From: Stuart Burnfield <slb -at- westnet -dot- com -dot- au>
To: Austechwriter <austechwriter -at- freelists -dot- org>, WAustechwriters <WAustechwriters -at- yahoogroups -dot- com>, Techwr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 17 Mar 2010 15:40:35 +0800 (WST)

Just spotted this in the newsletter:

Draft of the Community Council proposal to hire a Tech Writer

It's only a proposal at this stage, but sounds like a dream job for the right person.



The goal of this project is to provide a complete start to finish guide
(or set of guides) explaining how to get involved in
development. It should start with how to build Extensions, and move on
to the more complex core development.

Author requirements:

* Technical writer with experience in creating software
developer focused documentation
* Good knowledge of software development practices
* Basic programming experience/knowledge (Java, C++ etc.)
* Good knowledge of the software
* Good knowledge of UNO or comparable object models
* Excellent communication skills
* Experience with MS Windows, Linux, and OSX. Knowledge
of Solaris is an advantage
* Fluent English

Estimated Timeline:

Unknown - a reasonable estimate it 6 months assuming the techwriter is
familiar with producing developer level documentation.

Cost Estimates

Unknown - will be based on quotes from professional technical writers.


Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial:

Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at:

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Please move off-topic discussions to the Chat list, at:

Previous by Author: Re: Address this. . .
Next by Author: RE: Semantic(s)
Previous by Thread: Re: Uninstall or remove? (software)
Next by Thread: Senior vs. principal writer

What this post helpful? Share it with friends and colleagues:

Sponsored Ads