API Writer

Exploring API documentation

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.

December 18, 2008 Posted by Allen | API, SDK | | No Comments Yet

Move Networks Silverlight Developer Guide

Microsoft’s Silverlight is a web application platform that integrates multimedia and interactive content. A Silverlight solution works in conjunction with XAML and is scriptable with JavaScript. Silverlight applications are developed using Visual Studio and the .NET framework.

My assignment is to write a developer guide for implementing a Move Player in a Silverlight application. I downloaded and installed Visual Web Developer Express with SP1 and then installed the Silverlight Tools for Visual Studio 2008 SP1 add-on.  I’m using Silverlight’s built-in WPF UI framework to create the UI. To get started quickly, I read Scott Gu’s Silverlight Tutorial and completed lessons 1 and 2. 

I interviewed Richard, a Move Developer, who gave me a whirlwind tour of how to build a Silverlight application and use the Move Silverlight SDK to add a Move Player and controls. I used Wink to capture screen shots during our interview. After I got back to my desk, I edited frames and added comments to key frames. I will use this saved session as a frame of reference as I repeat the development process on my own.

I organized the document to introduce Move Player and Silverlight in context of developing a web application that plays Move streaming video content. I start with a brief introduction about the Move Player and Silverlight. 

Silverlight and Move Player are browser plug-ins. Silverlight is a platform for developing rich internet applications and Move Player delivers HD quality video over the internet with virtually no buffering.

This tutorial provides a quick introduction to implementing a player in a Silverlight web application. We will build a Silverlight application that contains a Move player, add controls and play a sample movie.

They are both web browser plug-ins and the Silverlight development environment requires a few configuration steps to get started. The SDK is actually a Silverlight project with some classes that makes it easier to work with the Move Player.

December 11, 2008 Posted by Allen | API, SDK | , , | No Comments Yet

Learning Java Head First

I purchased a copy of Head First Design Patterns. I read the first few pages and I was impressed by how accessible the content is, I actually remember what I read and I want to keep reading more.

Making information accessible is the first and most important step in good technical documentation. I love adding simple and easy to read illustrations to my own documents. A diagram, line drawing or even a simple model that shows how things connect together in context make a big difference.

Based on what I read, I ordered Head First Java, 2nd edition and Head First Object-Oriented Analysis and Design: A Brain Friendly Guide to OOA&D.  I didn’t intend to go on a book buying spree but I felt like it was the right thing to do.

January 30, 2007 Posted by Allen | API, SCJP | , | No Comments Yet