[documentation] Drupal API documentation
Gábor Hojtsy
gabor at hojtsy.hu
Fri Mar 13 09:36:10 UTC 2009
On Thu, Mar 12, 2009 at 10:21 PM, Steven Jones <darthsteven at gmail.com> wrote:
> 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!
There are quite a few of the internal APIs documented at
http://drupal.org/node/326 on various levels. I for one built out the
Localization API subsection and all its subpages:
http://drupal.org/node/322729
One useful tip I'd add from there is that IMHO it is a good idea to
include a cheat sheet up front, so that people can follow the detailed
docs along with a cheatsheet in hand. That cheatsheet includes common
mistakes and reference to tool to use to check whether you use the API
correctly :)
Gábor
More information about the documentation
mailing list