| |
|
|
SPECIFICATIONS & API DOCUMENTATION |
| Writers who are familiar with
application interface design documents often find that they contribute
to their development. Writers who can jump in during the specification
phase of the software development cycle learn product features long
before they have to write about them. This helps speed the product
documentation process, because the writer is already deeply familiar
with each feature and the overall product functionality.
Writers who document application program interfaces (APIs) have
their work cut out for them. API documentation is intended for developers.
When you write about APIs, you are documenting the methods, properties,
and events that are exposed to other applications. You provide the
syntax and code examples that developers need to complete their
programming.
Here are some examples.
|
| |
|
| Technical
specifications |
| Keypoint has worked with developers
to write technical specifications for information exchange protocols,
telephony software, and medical software. |
 |
| Programmer's
reference guides |
We have worked with developers
to document Oracle and Sybase SQL statement syntax and properties,
methods, and events for VBX and ActiveX controls.
|
|
|
|
