[documentation] Drupal API documentation

[Steven Jones]

Hi everyone,

At the documentation sprint last Saturday a number of us gathered to
talk about the documentation of Drupal's API, specifically Form API.
Although we planned and discussed FAPI specifically, there would be a
good case for applying the same style and structure of documentation
to other APIs.

I've attached a file that shows a very rough outline of what we came up with.
The documentation will be split into two components, one on a.d.o and
one in the d.o handbooks (actually two on d.o, if we include the
themer's guide.)

The forms reference on a.d.o is absolutely fine as is, so we'll leave
it alone, but the quickstart guide is going to get a trim and tidy up.

The handbook section will start with an overview of FormAPI and why
you'd want to use it. Then we'd have version specific information,
comprising a quick tutorial (in more depth than the one on a.d.o), a
section for code examples and a section explaining the 'inner
workings' of the API.

I'd like to get feedback on the proposed structure, and if there's no
major objections, I'm going to start moving the handbook pages around
on the weekend, people can then feel free to dive in and help where
they can.

Potentially we'll use this type of structure to document all the other
major APIs in Drupal, so comments are very welcome!

Regards
Steven Jones
ComputerMinds ltd - Perfect Drupal Websites

Phone : 0121 288 0434
Mobile : 07951 270 026
http://www.computerminds.co.uk
-------------- next part --------------
A non-text attachment was scrubbed...
Name: form_api_doc_layout.png
Type: image/png
Size: 63997 bytes
Desc: not available
URL: <http://lists.drupal.org/pipermail/documentation/attachments/20090312/975bb5d6/attachment-0001.png>