API Introduction

A good introduction helps the developer understand what is required to use the API. It states what is required, i.e. software, and encourages the reader to learn more. It usually includes points of reference, i.e. where to get started. Introductions help the developer to understand why an API was written. It also describes a few objectives or goals. It may announce new features that have been added.

Preparing a Technical Writing Portfolio

organizing writing samples

I organized my writing samples according to the company they were created. I created a nice cover pages to introduce myself and each company.

standardizing document format

I have written many documents in different mediums, i.e wiki, Word, Framemaker and hard copy. I decided to convert all of the writing samples into Word to make it consistent and easier to manage. If I wanted to show the document as it appeared in its original context, I took screen shots and then mounted the image inside of the Word document. The samples take a small hit in clarity but it achieves the desired end result.

obscuring confidential information

Not all information written in a document is “confidential”. To overcome the issue, I reviewed the document and obscured key information points such as IP addresses or key information captured in diagrams. Since I spent so much time gathering information and preparing the information, I think I understand what was confidential and what was not. The point is that a client can see how the document was organized, images placed and how information was written.

what skills are demonstrated?

Each document sample should demonstrate the use of your skills.  Each document represents hours of effort and care. In the end, when a client opens up the document, it is important to realize what the document says about my skills.

Do I have to include the entire document? I believe the Sample should be just enough to get the point across. It is like a Reader’s Digest of what you did and should provide enough information for the client to understand. Since it is likely they won’t read a 100 page user manual–choose a chapter.

interviewing tool

I also use a portfolio as a sales presentation. When in an interview, I can open up the document to support answers to questions. You can point out how you solved a particular problem and how it was done.

publishing

I created a Word file with the writing samples for each company. I kept the files separated by company to make it easier to assemble a final portfolio. package. I opened a new Word document and added document samples from each company according to a skill set that I wanted to emphasize. I generated the table of contents and then printed it as PDF. Now I can upload this for use on LinkedIn using their new slide show. I can create several different portfolios organized to show a specific skill set.