| |
|
|
TECHNICAL PUBLICATIONS |
 |
Software user guides |
|
Reference manuals |
|
Tutorials |
|
Application programming interface
(API) reference guides |
|
Functional design documents or design
specifications |
|
Database publishing |
|
| Award-winning documentation set:
We created the page design for a company that develops hospital evaluation
software, which includes complex algorithms and statistics requiring
simple explanations. We developed FrameMaker templates, created the
outlines, and wrote the text. We earned a Distinguished Award
from the Boston chapter of the Society for Technical Communication
and an Award of Excellence in the international competition.
|
|
 |
| User guide: We also created software
user guides for international trade software developed by BankBoston.
We prepared the book design to complement the bank's trade identity.
We worked from functional specifications, marketing requirements,
and prototype screens. The IT Director stated, "Your work is excellent."
|
|
| Web-based
tool user documentation: |
We produced HTML-formatted, online user documentation
for a Web tool designed for application developers. Click on the
image to see more information.
We participated in the Web Tools Development Group at SAS. We
included installation instructions for downloading applications
and documentation. See an example of HTML-formatted online user
documentation. View the captured images in the example or go to
http://www.sas.com/rnd/warehousing/quality/index.html
|
|
|
Database publishing:
Have you ever wondered how telephone companies produce their directories?
Can you imagine the quantity of data involved? Database publishing
comes to the rescue.
When a document includes large amounts of data stored
in databases, such as FoxPro or SQL, you can use database publishing
technology. This technology lets you create a recipe to manipulate
raw data directly from a database and assign style tags to each
data element. These style tags ultimately become the paragraphs
and headings in your document. After creating the recipe and “preparing
the ingredients,” all you need to do is import the processed
data from the database publisher into a desktop publishing tool.
|
 |
| We produce
a medical glossary using database publishing and FrameMaker. Keypoint
identified a solution for extracting and publishing medical data stored
in a Visual FoxPro database. We provide annual updates incorporating
national changes in medical options. |
|
|
| FrameMaker templates: Keypoint redesigned
the documentation set for a medical software company. We created FrameMaker
templates and user guides. |
|
|
| Programmer's reference guides: We have
worked with developers to document Oracle and Sybase SQL statement
syntax. We have also documented VBX and ActiveX controls for programmers.
|
|
|
Complete documentation solution: We planned
and implemented a documentation strategy for company's new products.
We designed a large help system, including software templates, a medical
glossary, and examples that displayed in different windows. The Senior
Writer remarked, "Thank you for your hard work, dedication to
quality writing and production, innovative ideas, and support."
We maintain versions of all documentation, spanning several reorganizations
and layoffs. The Marketing Specialist praised us by saying, "Your
talents never cease to amaze me. You have made us shine." We
also provide recommendations for authoring tool purchases.
|
|
|
