some people in irc disagreed with having a handbook page for every contrib module. they thought it would be too hard to maintain and better to use the project page and the readme.txt

http://drupal.org/node/100748 also says to add one (a habdbook page)
and #5 on best practices (http://drupal.org/node/188986)

What is the new/current best practices?

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Project: Drupal core » Documentation
Version: 6.x-dev »
Component: documentation » Correction/Clarification

Issues regarding the Drupal.org handbook go in the Documentation project issue queue.

yesct’s picture

yesct commented

AH! Thanks.

arianek’s picture

arianek commented
Category: task » support

my perception is that the project page just doesn't have space for the amount of documentation most modules need. and also, then the pages aren't grouped with other handbook pages on the same topic if they're all on the project page.

not all projects have handbook docs, but it is definitely the ideal to have some docs that ship with the module (including a help hook with a link to the handbook section http://drupal.org/node/632280), and then more extensive docs in the handbook.

arianek’s picture

arianek commented
Title: Is best practices out of date when it recommends a handbook page for every contrib module? » Define and document contrib docs best practices
Component: Correction/Clarification » New documentation
Category: support » task

also - paths should be /handbook/modules/project-name (that matches the project url /project/project-name and the help page in drupal at /admin/help/project-name. ping me or post here if you need any aliases made.

changing name to remind us that we need to document contrib docs best practices somewhere!

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Active » Closed (duplicate)

There are a couple pages currently listing contrib module documentation best practices. This issue discusses this and lists the places:
#955134: Clarify and complete the contrib module documentation guide

I think that issue has more information than this one, so I think I'll close this one as a duplicate if that is OK.