API Design
May 5th, 2004I ran across a couple older items on API design: Words of Wisdom on Designing Usable APIs and Think of Objects as Machines.
good API designs happens when designers think of … client programmers as users.
I wish more developers took this to heart. I’ll add my own law of API design:
Good API design makes common things simple while leaving uncommon things possible.
You can call it Moore’s law. 
When comparing two API possibilities, I often just count characters in a couple common examples of usage. To me, the API choice that results in fewer characters for the client programmer is usually the better API. This can tip the balance for subtle choices, or help evaluate two libraries which do the same thing.
All Posts
May 10th, 2004 at 6:22 am
Hi.
As an experiment the early versions of the SimpleTest API used TDD - Tutorial Driven Design. I wanted to write a mock object article and so wanted to add mocks to PHPUnit. I was working out the interface through the article. The problems I encountered caused me to write my own test case class and shelve the article for nearly a year.
Recently the API has been driven more by user requests, theft from the Java world (JWebUnit) and domain concepts (the web browser), but I am thinking that more than anything I should write another tutorial.
yours, Marcus
May 10th, 2004 at 4:11 pm
Tutorial Driven Design - you may be onto something. Seriously. Course it’s going to be hard for managers to swallow: “All coding begins… with a tutorial”
May 12th, 2004 at 6:51 pm
Maybe thats why I like SimpleTest so much. Designing the application by writing user documentation is not a new idea. I think that taking a tutorial oriented approach is a great idea because it focuses on the tasks that a user would want to do. User documentation that simply enumerated screens and menu items or that simply enumerated classes would not be good candidates for driving development. They are too much like the big design up front that the agile methodologies are trying to avoid. Writing tutorials doesn’t sound much different than writing stories. (use cases, essential use cases, scenarios or whatever you want to call them, I have a fondness for task based UI design.)
October 11th, 2004 at 12:39 am
design by documentation is not new. The Sperry Univac 1100 mainframe operating system was not written until the reference manual had been written and approved.
It’s still a great idea. Anyone want to collaborate on a book?
November 6th, 2006 at 12:51 am
Looking+for+information+