Re: [Framework-Team] Re: Fwd: Including aDocumentation section in each PLIP
Wichert Akkerman <[email protected]>
| Newsgroups | gmane.comp.web.zope.plone.documentation |
|---|---|
| Message-ID | <[email protected]> |
Previously Dylan Jay wrote: > Hi, > > My impression from the thread was the framework team aren't resisting > because they don't value documentation. They are resisting because the PHC > soup is too hard to "know well". I don't think there's been any discussion on it actually. But indeed, I do not think it is reasonably to ask PLIP implementers to find all relevant entries in PHC. What I want from PLIP implementers is the following: - a description of what changes for developers (ie new patterns to use) - a description of what changes for users (ie new patterns to use) - proper documentation for new features. All or none of those may be doctests, as long as they are readable documentation, not tests with some narrative in between code snippets. That should give the documentation more than enough data to find and update documetation on plone.org Wichert. -- Wichert Akkerman <[email protected]> It is simple to make things. http://www.wiggy.net/ It is hard to make things simple. ------------------------------------------------------------------------- This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK & win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world http://moblin-contest.org/redirect.php?banner_id=100&url=/