[Framework-Team] Fwd: Including a Documentation section in each PLIP

[Tom Lazar]

+1 i mean, what's not to like? ;-)

seriously, i think it's a great idea to include documentation right  
from the start and coordinate with/delegate to the docs team.

question: where do we put this to make it official policy?

cheers,

tom

On 13.11.2008, at 19:49, Steve McMahon wrote:

> Hi Framework Team,
>
> Copied below is a proposal from Israel Pérez (dukebody on IRC) for
> adding consideration of documentation impact to PLIPS. It's been
> discussed on the doc team list, and folks really like the idea.
>
> What do you think?
>
> Steve
>
>
> ---------- Forwarded message ----------
> From: Israel Saeta Pérez <dukebody at gmail.com>
> Date: Thu, Nov 13, 2008 at 10:30 AM
> Subject: Including a Documentation section in each PLIP
> To: Steve McMahon <steve at dcn.org>
>
>
> Dear Framework Team members:
>
> I've a proposal I believe could be very helpful for keeping
> documentation up-to-date with the implementation of new features:
> including a mandatory "Documentation" section in each PLIP.
>
> The person who submits the PLIP, with help from the documentation team
> if necessary, would be responsible for listing the main documents in
> plone.org that would be affected by the PLIP and why, and therefore
> need to be updated to complete the implementation of the PLIP
> successfully.
>
> The PLIP submitter wouldn't be responsible for updating the listed
> articles him/herself compulsorily, but would have to interact with the
> doc team to get that done.
>
> Thanks for your time!
>
> --
> Israel Saeta Pérez
> Plone Documentation Editor
>
>
>
> -- 
>
> Steve McMahon
> Reid-McMahon, LLC
> steve at reidmcmahon.com
> steve at dcn.org
>
> _______________________________________________
> Framework-Team mailing list
> Framework-Team at lists.plone.org
> http://lists.plone.org/mailman/listinfo/framework-team
>