Vacation reply

[b***@hotmail.com]

--
Pending work: http://drupal.org/project/issues/documentation/
List archives: http://lists.drupal.org/pipermail/documentation/

[Gábor Hojtsy]

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/

[b***@hotmail.com]

--
Pending work: http://drupal.org/project/issues/documentation/
List archives: http://lists.drupal.org/pipermail/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

Post by Gábor Hojtsy

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
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/

[b***@hotmail.com]

--
Pending work: http://drupal.org/project/issues/documentation/
List archives: http://lists.drupal.org/pipermail/documentation/

[Gábor Hojtsy]

Hi Dipen,

 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?

There is no special tool required. You can easily do a cheat sheet
with OpenOffice or Word, just use text boxes with page attached
positioning (ie. do not use the regular paragraph flow).

Gábor
--
Pending work: http://drupal.org/project/issues/documentation/
List archives: http://lists.drupal.org/pipermail/documentation/