[documentation] Drupal API documentation

[Dipen]

hi gabor,
 I've seen cheatsheet made by you and was very fancy and jazzy. I've never
made one myself but would like to, do you have any special recipe apart from
the knowledge base and thorough planning? Do you use any special tools etc?

Thanks



On Fri, Mar 13, 2009 at 3:06 PM, Gábor Hojtsy <gabor at hojtsy.hu> wrote:

> 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
> --
> Pending work: http://drupal.org/project/issues/documentation/
> List archives: http://lists.drupal.org/pipermail/documentation/
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.drupal.org/pipermail/documentation/attachments/20090313/da051600/attachment.htm>