User:Zakgreant/pairdoc/2010-11-23

A discussion between User:Catrope, User:Reedy and User:Zakgreant about the API.

Audience(s) for API

 * 1) developers
 * 2) hobbyists

Issues with current docs

 * Current docs miss some key concepts - in particular, the quickstart goes much too quickly
 * MediaWiki.org docs out of sync with embedded docs - see bkdir for example
 * Generators need to be better explained and demonstrated (zak: 2x roan's mediawikiwiki article on the topic.)
 * FAQ is out of date
 * Impementation API:Implementation_Strategy is really out of date

Ideas

 * Auto-create new MediaWiki.org pages with param info - one page per param
 * Transclude auto-generated param info pages into wikis that contain the exended docs on the feature
 * Use standard/autogenerated page name scheme for features (perhaps just the API namespace and param/module name?)