| |
| Technical Writing |
| |
| Technical Documentation |
Technowr ites also creates documentation targeted at the product developers or engineers. This includes the following.
|
| |
| API Documentation |
Application Program Interface documentation tells the developers how various APIs can be used to share/exchange data with other interfacing product/technologies. API documents have in-detail technical information about usage, format, and syntax, along with examples. |
| Administrator's Guide |
It is written for the product's administrator. It is written in the techn ical language that the administrator uses. It has information about maintaining the users and the data. It contains detailed technical information about the application's structure and its workflows. |
| Use Cases |
Use cases document the various users and their expectation (usage of the system/application). These cases are written before or at the time of developing the system's architecture. For development projects the use cases may be developed in tandem with the client. |
| Command References / Function References |
The development team often creates a lot of components that can be re-used. Command and Function references document these components so that the team members can share their knowledge and increase their efficiency. |
| Test Cases |
An application is thoroughly tested before it is published. Testing includes hundreds (in some cases, thousands) of tests executed as per many test scenarios. Test cases are documents written to record these test scenarios, testing conditions, expected outcome and actual outcome. |
|