Cancelled

DocBook updates for product manual

We are updating one of our products & are moving all product manuals into DocBook. This project will consist of mainly incorporating screen shots & documenting all menu based options within framework of an already existing docbook manual. The chapter framework exists & some text exists from the older product, but we have added new features. We will provide a virtual machine (SUSE 10) that is configured & has the existing content - using VMPlayer (Windows or Linux), content can be edited in one of several editors in the VM. Windows 2000/XP or Vista is required to run the product (important to reference actual operation & document steps required to set/change features). A good command of written English is important, along with familiarity of DocBook (or HTML, or other markup language - someone experienced in DocBook will be able to perform the task much quicker). A large market for this product is older computer users, so clear, concise, and step-by-step instructions are critical. We will provide screen shots, but the incorporation into the book framework, and actual documentation describing features will be your task. We will provide a list of all features & options to be documented. The scripts to "parse" and build targets into PDF & HTML exist, and will work with the provided book framework. ALL updates to the chapters must also parse & build correctly. Adobe Reader & Browser to view targets are on the VM. As a quick overview, here is the task:

1) Obtain VMPlayer from VMWare

2) We will provide VM (in Zip format) and product (for Windows)

3) Verify operation of VM, build existing manual

4) Edit chapters, add in screen shot markup language (examples provided), document steps / features

5) Verify your additions build correctly

6) Zip up changes & return as your deliverables

## Deliverables

We will provide a zip file of scripts, templates, etc. to create the manual. The chapter files are .sgm files (standard text files with docbook markup). You will need to add images (screen shots), and updates to several chapters. There is a clean script which cleans up working / temp files, and using "zip -rf imghelp *" will add/freshen any updates you perform. Returning this zip file (with new text, screen shots, etc. that can successfully build the HTML/PDF files) is what will be required. Note the book structure, chapter files all exist - what we need is contextual description of the menu options and operation of the product.

## Platform

Windows 2000 or XP, Vista preferred for screen shots. VMPlayer can run on these Windows platforms, or most Linux platforms. (You will need VMPlayer to udpate help files)

Skills: Article Rewriting, Copywriting, Research Writing, Technical Writing

See more: writing templates, writing steps, writing machine, what is a temp, text markup, technical writing pdf, technical writing manuals, technical description of product, step up to writing, market description of a product, manual html 5 pdf, in need of editors, html 5 command, english copywriting pdf, c++ parse html 5, content writing platforms, concise description of a product, writing technical documentation, what is markup language, what is a markup language

About the Employer:
( 1 review ) Paso Robles, United States

Project ID: #3139194

1 freelancer is bidding on average $255 for this job

medix

See private message.

$255 USD in 14 days
(41 Reviews)
4.5