Author: allison Date: Sat Dec 15 05:00:55 2007 New Revision: 23932 Modified: trunk/docs/pdds/pdd00_pdd.pod
Log: [pdd] Clarify on the kind of content expected in PDDs. Modified: trunk/docs/pdds/pdd00_pdd.pod ============================================================================== --- trunk/docs/pdds/pdd00_pdd.pod (original) +++ trunk/docs/pdds/pdd00_pdd.pod Sat Dec 15 05:00:55 2007 @@ -46,14 +46,13 @@ =back -PDDS B<should not> discuss the implementation details or trade-offs, unless -they absolutely have to. Such implementation documentation should go in the -relevant F<docs/dev/*.pod> file. On the other hand, PDDs B<should> document -design trade-offs, i.e. the paths not chosen. - -These guidelines may seem fuzzy. The line between "design" and -"implementation" is a murky one. Still, please try to adhere to this design -for Parrot design documentation. How you implement it is up to you. :-) +PDDs don't generally discuss the implementation details. Low-level +implementation documentation, the maintainer's guides, should go in the +relevant F<docs/dev/*.pod> file. + +PDDs may document design trade-offs, i.e. the paths not chosen. In many cases +they don't, just to keep the PDDs relatively short and readable. The history +of Parrot's design is retrievable from the source repository. =head1 IMPLEMENTATION
