Skype Developer Zone logo
  • Login
  • Home
  • Tools & SDKs
  • Docs & Samples
  • Support
  • Certification
  • Community
  • Shop
  • Blog

Welcome to Triona Carey

By My status  on November 25, 2005 in Developer Blog.

Burrrr it’s cold. Just as I was going to bed last night I looked out the window to see the snow falling. We didn’t get a lot, but there are a few patches where it settled.

I can’t remember the last time it snowed in November.

This week we had a new starter at Skype who is a technical documentation writer and has been hired to write and manage the API documentation, so please welcome Triona Carey to the team.

Triona has a mammoth job ahead of her, I tired working on the docs but it blew my brains trying to separate the API into Linux, Windows and Mac, and have source code in different languages. Triona has many years experience building documentation so I am sure we can figure something out between us.

My home office is being to look like a bit of a warehouse store room, and its starting to get noticed by “she that must be obeyed”. So we need to have a bit of a competition to get rid of some of this stuff.

So have think about what you want from the API documentation and post your thoughts below, I’ll pull a winner at random and send them a prize.

In the run up to Christmas I will have lots of things to give away, so make sure you check back often to see what you need to do to win!

Remember - you have to be in to win.

Bookmark and Share

View blog reactions

Comments

Hi Lester, perhaps the most obvious but in my opinion the most critical aspect to any good API documentation is short examples for each section being described. Being able to refer to how the instruction is used along with it's syntax is one of the easiest aspects of using Microsoft's developer guides.

Having many platforms and the possibilities of multiple languages to choose from obviously makes this a mountain of a task but perhaps the main languages can be catered for and examples built by contributions from the developer community. Perhaps this later aspect could be run on a 'points' system where users could post a question and the community could offer solutions with the most appropriate being allocated points for their answer. These points could be purchased originally by the questioner, contributed by Skype or a mixture of both. Maybe run along similar lines to Expert-Exchange.com

websetters | Friday, Nov 25

Triona here - hi all, looking forward to getting to know you and to hearing what you need and want from our docs. Ideally we'd work from the must haves to the like to haves down through to the wouldn't it be great. With your input and help it will be great because Skype is. Thanks in advance for your ideas.

triona.carey | Friday, Nov 25

I think you should at least include the following information in the documentation (I've framed it as I would have it layed out):

Introduction
  What is Skype
  What is Skype API
  How to report a bug
  Revision History

Skype API
  Windows specific details (SendMessage(), COM Wrapper, etc...)
  Mac OS X specific details (provided wrapper, etc...)
  Linux specific details (DBus, etc...)
  API Commands
   Command X
    Syntax
    Usage
    Common mistakes
    Compatibility issues (older versions, cross-platform, etc...)
    Example
   Command Y
   ...
  Known Issues

michael.b.price | Thursday, Dec 1

Cheers Michael I have been in contact with you via Skype to send you something.

Lester

lestermadden | Friday, Dec 2

Comment on this post

(If you haven't left a comment here before, you may need to be approved by the site owner before your comment will appear. Until then, it won't appear on the entry. Thanks for waiting.)

Please read our comment guidelines before posting your comment.

Back to index

Subscribe to this blog
What? Tell me more…

using RSS Subscribe
via Bloglines Subscribe in Bloglines
using Newsgator Subscribe in NewsGator Online
with MyYahoo
with Google Add to Google
with My AOL Add to My AOL
with Anothr.com Subscribe by Anothr
with netvibes Add to Netvibes
with email Get email updates
Skype Developer Newsletter

Sign up now for all the latest news, tips and tricks on using Skype Public API.

Skype Blogs
  • Share Skype Blog
  • Heartbeat
  • Developer Zone
  • Business
  • Skype Gear
  • Security
  • Garage
  • Mac
  • Linux
  • Eesti keeles
  • 日本語
  • Česky
  • Deutsch
  • Français
  • Italiano
  • Brasil
  • United Kingdom
  • Polski
  • United States
  • 한국어

Recent posts

  • Developer Zone and Jira down for maintenance
  • The future of Skype Extras
  • Skype name recognition in Skype 4.1
  • Summer break in Extras update from 20th July to 9th August
  • Version 1.0.32 of Skype4COM is now available for download
  • Skype for Windows 4.1 Beta is Live
  • CTSS - Chat Translator and Speaker for Skype
  • Router Lab
  • A pause in Extras update until 23rd April
  • Jason Fischl joins Skype as Director of Developer Relations

Archives

  • October 2009
  • September 2009
  • August 2009
  • July 2009
  • June 2009
  • May 2009
  • April 2009
  • March 2009
  • December 2008
  • November 2008
  • October 2008
  • September 2008
  • August 2008
  • July 2008
  • June 2008
  • May 2008
  • April 2008
  • March 2008
  • February 2008
  • January 2008
  • December 2007
  • November 2007
  • October 2007
  • September 2007
  • August 2007
  • July 2007
  • June 2007
  • May 2007
  • April 2007
  • March 2007
  • February 2007
  • January 2007
  • December 2006
  • November 2006
  • October 2006
  • September 2006
  • August 2006
  • July 2006
  • June 2006
  • May 2006
  • April 2006
  • March 2006
  • February 2006
  • January 2006
  • December 2005
  • November 2005
  • October 2005
  • September 2005
  • August 2005
  • July 2005
About us · Partners · Jobs · Prices · Security
Privacy policy · Legal · © 2009 Skype Limited