[yocto] RFC: Yocto Project Documentation Change Process for Features and Bugs

[Liu, Song]

Hi all,

We have been trying to make sure that documentation changes needed for features and bugs happen early in the release cycle. What we have done in the past release is to remind people in various meetings, forums and emails. Most of the doc changes needed did get into the release. But lots of them seem to have happened very late in the release cycle. After some discussion within the team, we have the following proposal:


1.       Add a new field in bugzilla for each item, it could be named 'DocChange'. It has 4 values: Blank (not set yet), Yes (needed) , No (not needed), Done (completed)

2.       For features, the default for this field is 'Yes' since most of the feature will need doc changes. ScottR will work with the owner of the feature to get doc changes planned early and completed for the release. It's the feature owner's responsibility to determine whether doc change is really needed or not and provide related material, although ScottR can be consulted for this.

3.       For bugs, the default of the field is 'blank'. When a bug is set to 'resolved' by the owner, the owner will be reminded to go through a step to set the 'DocChange' field value. If it is 'Yes', ScottR will work with the owner to get the doc updated. But again, it's the owner's responsibility to determine whether doc change is needed and provide related material, although ScottR can be consulted for this.

4.       For each feature/bug, QA will verify the doc change is completed before putting the item in 'verified' state.

What's added in a developer's workflow:

1.       Determine whether a feature needs doc change or not, if yes, provide material to Scott Rifenbark.

2.       While resolving a bug, decide if doc change is needed. If yes, provide material to ScottR. (A couple more mouse clicks?)

What QA needs to do:

1.       When a feature/bug is put into verified state, verify doc change is completed, which may include actually checking the related doc.

Please let me know if you have any questions, concerns or other suggestions.

Thanks,
Song

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.yoctoproject.org/pipermail/yocto/attachments/20130617/81cd141c/attachment.html>