[Developers] Developing Applications Documentation

Phil Gochenour phil at metaweb.com
Tue Jul 29 17:57:31 UTC 2008


Hi all,

I've been working on updating the documentation in the Help Center  
under Developing Applications, and wanted to bring a couple things to  
your all's attention and solicit some feedback.

There are three major things you''ll notice: I've created two areas  
for user-contributed content, and done some major updating on the API  
services. The two user-contributed content areas are Application  
Developer Tips and The MQL Cookbook.  Here I took stuff that was  
previously typed as Freebase Tips and split them into these categories  
(although the distinction between a developer tip and a MQL recipe  
isn't always that clear cut). I've put instructions in the "index  
page" topic on how you can add your own tips/recipes, type them, and  
complete the property information. For now I would like to keep all of  
these as Help Topic types, rather than Freebase tips, since these  
means they will appear with other Developer documentation in the  
filter view of Help Topic.

The API updates includes putting all essential information up front in  
the description in a table format for easy reference, as well as  
adding in services that are public but were not published. I've not  
done anything to the Freebase API Services type schema, as I've not  
come across any compelling reasons to do so - however, I'd love to  
hear feedback from you all on this. In my view, there's not much that  
can be added to the schema in terms of structured information that  
would be useful, so I've focused on creating better information in the  
descriptions. If there are things that you all think could be added to  
the schema that would be useful, please let me know about them.

In addition to those things, I'd welcome any feedback you all have  
about additional documentation you'd like, etc.

Phil
-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 3738 bytes
Desc: not available
Url : http://lists.freebase.com/pipermail/developers/attachments/20080729/18fc88e4/attachment.bin 


More information about the Developers mailing list