SDK, API and Programmer Documentation
Backed by over a decade of software engineering experience, I specialize in software manuals, API, and SDK guides. I speak the language of both your programmers and your customers and can deliver top quality documentation while enabling your team to remain focused on product development.
Below are few samples of my API project work. I wrote the PostSharp API documentation for PostSharp’s design pattern library. The process involved compiling and building against their assembly using Visual Studio, as well as some minor reverse engineering to derive the documentation.
For Let’s Buy Local, I used CURL and Postman to execute the REST API requests against their endpoints, and worked closely with their developers to document the various parameters. Their API allows developers to build online sales systems.
Over the years I’ve also worked on a number of projects for Simba, a Vancouver-based software company which provides an SDK for building custom ODBC and JDBC database drivers. The Java-based SDK Guide below, is one such example of a programmer-oriented manual that I created for developing a JDBC database driver. I’ve also created similar guides for their C# and C++ SDKs. For these and other guides, I used Eclipse, Visual Studio, GCC, and various database test applications under both Windows and Linux, to develop these guides for the respective platforms.
Click to view samples from past projects: