API design
Jacob Farber
jacob.farber at utoronto.ca
Thu Apr 23 17:07:10 UTC 2009
Hi,
I would like to share an idea I had for a cleaner, more readable and useable API page layout. I have attached a pdf mockup of what a sample might look like - even though some of the data is real, it's just filler.
There are a few things I would like to emphasize from this concept:
* Almost all categories are collapsible, enabling a customized reading experience
* Overview meta data is stored at the top with a contextualized help link (?)
* JIRA issues for the code in question are quickly accessible
* There is a Glossary of terms unique to Infusion and the specific content of the page. Some are unique to the framework, others might just be explanations (in this mockup the [Selector] link would point to a glossary definition saying something like "type Selector = String, jQuery Object, Element, or Function returning an Element or jQuery Object")
* Color coding
* Explicitly obvious nested structures
These ideas are just conceptual. Implementation is an entirely different concern.
This is a very rough draft, so all feedback is very welcome!
Thanks
Jacob
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.idrc.ocad.ca/pipermail/fluid-work/attachments/20090423/1280f44e/attachment.htm>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: C:\Documents and Settings\Jacob\Desktop\docs.pdf
Type: application/pdf
Size: 31850 bytes
Desc: C:\Documents and Settings\Jacob\Desktop\docs.pdf
URL: <https://lists.idrc.ocad.ca/pipermail/fluid-work/attachments/20090423/1280f44e/attachment.pdf>
More information about the fluid-work
mailing list