Query Language - SDK

Project description and scope 

For this project I needed to provide SDK-style documentation for a proprietary query language. I received the bulk of the text from an engineer, and I created examples and standardized the terminology used throughout the document and modified the document to match the corporate style guide.

Output types and deliverables

This project was delivered in two versions: PDF and online WebHelp. I developed two style sheets, one for each output.

Tools used

For this project I used MadCap Flare v3.1 as the help authoring tool and Microsoft Word 2003 (the tool the developer used to write the first draft).

Skills showcased

I was able to turn this project around within several days; this project shows my ability to work quickly to finish a new project. This project also demonstrates that I'm comfortable writing SDK/query language documentation for an audience of developers.

Writing sample information

The image at the top of this page the content rendered with the online styles; the image below shows the content with the printed styles.

Licensing restrictions prohibit me from publishing any more of the project in this portfolio.