[svn:parrot] r36586 - trunk/docs/book

Allison Randal allison at parrot.org
Wed Feb 11 21:32:09 UTC 2009


Will Coleda wrote:
> Does it make sense to duplicate this information in the PMC file
> itself and in the book?
> 
> If we want it in both places, can we just copy it when we build our
> docs, rather than having a cut and paste?

The book should never be a copy of the project docs. When in doubt 
whether to put a section of documentation in the book or in the project 
docs, the rule is:

- project docs should contain the detailed, comprehensive information.

- book should act more as a guide through the documentation, with 
information on how to get started, demonstrations of common tasks, and 
pointers to more information in the project docs.


Some of what's currently in the book needs to be moved out to the 
project docs (I've started making changes like that).

Allison


More information about the parrot-dev mailing list