Tech WriteInternet
MarCom
Consult
Project
Index
Technical Writing
The foundation of all our client
projects is strong technical writing skills. Whether you need a user manual,
newsletter, sales brochure, or a Web site, nothing is a substitute for great
writing skills and a strong understanding of the high-tech industry.
We bring over fifteen years of technical writing experience to every project.
The following are some of our contract technical writing solutions:
|
Symantec Corporation
|
NetDynamics |
| Avolent,
Inc.
|
Harvest
Technologies |
Symantec Corporation
This modular approach saves considerable time when
managing feature changes and results in a short turn-around
between the two product releasess. The help systems focus on
development procedures, components, object properties and event reference material,
and database connectivity tasks.
The two help systems total over 1,000 topics.
NetDynamics
Solution: Designed an HTML template that allows the
document to be cleanly print from the customer's browser. Maintained
a traditional manual layout and organization so that the
printed pages are easy to read. Worked with the engineers
to determine event process flow and management, described how to
use the API, and explained commonly used Java classes.
Service: Online help for Visual Café 1.0, 2.0 and Visual Café Pro 1.0, 2.0
Task: Architect and author a Windows 95 online help
system for the first release of Symantec Visual Café and Visual
Café Pro. And, maintain the help system through release 2.0.
Visual Café and Visual Café Pro are
Java application development tools for Java developers.
Solution: RoboHelp was used to develop a full context-sensitive
help system that consists of several smaller
help projects. This modularization allows other writers to
contribute to the help system with little project impact. And,
by grouping product features carefully, the Visual Café
Pro help project can be built by simply
including two extra help projects into the base Visual Café
set.
Service: Online manual - NetDynamics
Java API Programmer’s Guide 2.0
Task: Write a new programmer’s guide for NetDynamics,
a Web application development tool.
The guide must complement
the NetDynamics API JavaDoc online reference.
Satisfy the customers' need for online document
delivery and printability.
Award: This document won an Award of Achievement in the
Society of Technical Communication’s 1996 Northern
California Technical Communication competition.
Service: Online
help for NetDynamics 2.0
Task: Create a context-sensitive Windows 95 online help
systems for NetDynamics user tasks and the administration utilities. tools.
Solution: Developed two online help systems using RoboHelp.
The systems include context-sensitive help, wizard help, management tasks,
object properties reference, development tasks, and administration tool
help. The two help systems consisted of over 500 topics.
Avolent
Service: Programmmer documentation for BillCast 1.2.
Management of the Technical Publication group, including hiring.
Task: Lead the complete redesign and development of
an extensive manual set for a commercial Internet billing application
based on ATG Dynamo and Java. Manage and build the technical writing team.
Solution: Reorganized and designed the new manual set
for the next product release. Worked closely with engineering and customer
services to understand customer needs and streamline the technical information
exchange process between groups. Hired two new writers and laid out a
new documentation process.
Harvest
Technologies
Service: Product documentation writing
Task: Write the documentation for the first product
release.
Solution: As sole technical writer, developed a documentation
plan and worked with company founders and lead engineers to define customer
and company goals. Developed the manual templates.
Home | Services | Solutions | Clients | Partners | About | Contact | Map