This is an automated email from the ASF dual-hosted git repository. holivier pushed a commit to branch trunk in repository https://gitbox.apache.org/repos/asf/ofbiz-plugins.git
commit e314fc7c99cdf39a7cc21f83ea2de0a0ad24c8ea Author: holivier <holiv...@apache.org> AuthorDate: Tue May 5 18:55:18 2020 +0200 Documented: ofbiz-plugins / Scrum, migration of docbook help files to asciidoc (OFBIZ-11587) scrum.adoc created and re-organize adoc files to have them similar to menu name and menu items order --- docs/asciidoc/plugins-user-manual.adoc | 1 + .../docs/asciidoc/_include/scrum-add-sprint.adoc | 43 +++++++ .../_include/scrum-backlogItem-content.adoc | 28 ++--- .../asciidoc/_include/scrum-default-tasks.adoc | 28 ++--- .../src/docs/asciidoc/_include/scrum-members.adoc | 47 ++++++++ .../src/docs/asciidoc/_include/scrum-my-work.adoc | 32 ++--- .../docs/asciidoc/_include/scrum-open-test.adoc | 44 +++++++ .../_include/scrum-product-backlog-item.adoc | 74 ++++++++++++ .../_include/scrum-product-categories.adoc | 30 ++--- .../asciidoc/_include/scrum-product-overview.adoc | 31 +++++ .../src/docs/asciidoc/_include/scrum-product.adoc | 76 ++++++++++++ .../asciidoc/_include/scrum-project-sprint.adoc | 132 +++++++++++++++++++++ .../docs/asciidoc/_include/scrum-timeSheet.adoc | 28 ++--- scrum/src/docs/asciidoc/scrum.adoc | 93 +++++++++++++++ 14 files changed, 605 insertions(+), 82 deletions(-) diff --git a/docs/asciidoc/plugins-user-manual.adoc b/docs/asciidoc/plugins-user-manual.adoc index 789622e..c30b58e 100644 --- a/docs/asciidoc/plugins-user-manual.adoc +++ b/docs/asciidoc/plugins-user-manual.adoc @@ -37,3 +37,4 @@ include::../../myportal/src/docs/asciidoc/my-portal.adoc[leveloffset=+1] include::../../projectmgr/src/docs/asciidoc/project-mgr.adoc[leveloffset=+1] +include::../../scrum/src/docs/asciidoc/scrum.adoc[leveloffset=+1] \ No newline at end of file diff --git a/scrum/src/docs/asciidoc/_include/scrum-add-sprint.adoc b/scrum/src/docs/asciidoc/_include/scrum-add-sprint.adoc new file mode 100644 index 0000000..83342b4 --- /dev/null +++ b/scrum/src/docs/asciidoc/_include/scrum-add-sprint.adoc @@ -0,0 +1,43 @@ +//// +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +//// +This screen includes details that need to create sprint. + +== Fields Description +. "Sprint Name" field should contain the name of sprint. +. "Description" field should contain the description of sprint. +. "Start Date" field should contain the starting date of the sprint. +. "End Date" field should contain the ending date of the sprint. +. "How many Sprint Backlog(s)?" field should contain how many Sprint Backlog do you want from the top of Product Backlog. + +== How to create the sprint +. Fill all of fields. +. Click at the submit button. + += Update Sprint. +This part use to update Sprint backlog such as planned hours, .... + +. Product Name +. Sprint Name +. Sprint Goal +. Status +. Start Date +. End date +. Planned Hours (Integer or floating point). +. Sprint Length Weeks +. Click the update button to update the Sprint Backlog. diff --git a/docs/asciidoc/plugins-user-manual.adoc b/scrum/src/docs/asciidoc/_include/scrum-backlogItem-content.adoc similarity index 56% copy from docs/asciidoc/plugins-user-manual.adoc copy to scrum/src/docs/asciidoc/_include/scrum-backlogItem-content.adoc index 789622e..ec2c833 100644 --- a/docs/asciidoc/plugins-user-manual.adoc +++ b/scrum/src/docs/asciidoc/_include/scrum-backlogItem-content.adoc @@ -16,24 +16,22 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. //// -= Apache OFBiz Plugins -The Apache OFBiz Project -Release trunk -:imagesdir: ./images -ifdef::backend-pdf[] -:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] -:source-highlighter: rouge -endif::[] -:toc: -:sectnums: += Backlog Item Contents +This screen use for uploading any contents that concern to the Backlog Item. +The screen consists of : -include::../../birt/src/docs/asciidoc/birt.adoc[leveloffset=+1] +. Backlog Item Content List +. Add Backlog Item Content -include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1] -include::../../ebaystore/src/docs/asciidoc/ebay-store.adoc[leveloffset=+1] +== Backlog Item Content List +To show the list of contents by Content Type Id and Content Name. +There are 2 buttons in each content: -include::../../myportal/src/docs/asciidoc/my-portal.adoc[leveloffset=+1] +. Delete : To delete the uploaded content +. Download : To download the uploaded content -include::../../projectmgr/src/docs/asciidoc/project-mgr.adoc[leveloffset=+1] +== Add Backlog Item Content +To upload the content. +The content can be classified by choosing the Content Type Id and Mime Type Id. \ No newline at end of file diff --git a/docs/asciidoc/plugins-user-manual.adoc b/scrum/src/docs/asciidoc/_include/scrum-default-tasks.adoc similarity index 56% copy from docs/asciidoc/plugins-user-manual.adoc copy to scrum/src/docs/asciidoc/_include/scrum-default-tasks.adoc index 789622e..2a868de 100644 --- a/docs/asciidoc/plugins-user-manual.adoc +++ b/scrum/src/docs/asciidoc/_include/scrum-default-tasks.adoc @@ -16,24 +16,20 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. //// -= Apache OFBiz Plugins -The Apache OFBiz Project -Release trunk -:imagesdir: ./images -ifdef::backend-pdf[] -:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] -:source-highlighter: rouge -endif::[] -:toc: -:sectnums: += Default Tasks +This screen use for setting the task that will be generated automatically when the backlog is create. +The screen consists of : -include::../../birt/src/docs/asciidoc/birt.adoc[leveloffset=+1] +. Create A Default Task button +. Default Task List -include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1] -include::../../ebaystore/src/docs/asciidoc/ebay-store.adoc[leveloffset=+1] +== Create A Default Task button +To create a new default task. +When click on the button the screen appears Edit Default Task instates the Default Tasks List. -include::../../myportal/src/docs/asciidoc/my-portal.adoc[leveloffset=+1] - -include::../../projectmgr/src/docs/asciidoc/project-mgr.adoc[leveloffset=+1] +== Default Tasks List +To show Default Tasks List,when click it's name the screen appears Edit Default Task. +== Edit Default Task +The screen appears the criteria that can be updated. \ No newline at end of file diff --git a/scrum/src/docs/asciidoc/_include/scrum-members.adoc b/scrum/src/docs/asciidoc/_include/scrum-members.adoc new file mode 100644 index 0000000..3c598cc --- /dev/null +++ b/scrum/src/docs/asciidoc/_include/scrum-members.adoc @@ -0,0 +1,47 @@ +//// +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +//// += Scrum Members +Any activity in any of the Scrum actions need people who are members of the project. + +So create the people which will be involved in the "Members Tab". +You need to enter an existing person and company (partyGroup). + +Persons and companies (PartyGroup) need to be added in the party component first before they can be used in the Scrum component. + +== Add members into scrum component +The purpose of this is to add member into the scrum component. +There are 3 screenlets to perform on the screen include with: + +. Find Scrum Member +. Add Scrum Member +. Scrum Members List + + +== Find Scrum Member +To find member who is in the Scrum Component.There 5 criterias to identify - Company,Last Name,First Name,Middle Name and Group Id. + +Then, click the button "Find" the solution will display on the Scrum Members List screenlet. + +== Add Scrum Member +To add the member the Scrum Component by selecting at Company and Person and Group Id. +Then, click the button "Add" the solution will display on the Scrum Members List screenlet. + +== Scrum Members List + +This screenlet will show all of member who are in the Scrum Component by default. +There is the remove button for each list to remove member out form the Scrum Component. \ No newline at end of file diff --git a/docs/asciidoc/plugins-user-manual.adoc b/scrum/src/docs/asciidoc/_include/scrum-my-work.adoc similarity index 52% copy from docs/asciidoc/plugins-user-manual.adoc copy to scrum/src/docs/asciidoc/_include/scrum-my-work.adoc index 789622e..c9845db 100644 --- a/docs/asciidoc/plugins-user-manual.adoc +++ b/scrum/src/docs/asciidoc/_include/scrum-my-work.adoc @@ -16,24 +16,26 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. //// -= Apache OFBiz Plugins -The Apache OFBiz Project -Release trunk -:imagesdir: ./images -ifdef::backend-pdf[] -:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] -:source-highlighter: rouge -endif::[] -:toc: -:sectnums: += My Work +This perform to work's information and update timesheet -include::../../birt/src/docs/asciidoc/birt.adoc[leveloffset=+1] +. Current Timesheet +. Open task assigned to me +. Assign an exist Task to me +. Add a new weekly Timesheet +. Timesheet list of -include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1] +== Current Timesheet +To update a member's Timesheet and the set the task's status to complete when the task has been done. -include::../../ebaystore/src/docs/asciidoc/ebay-store.adoc[leveloffset=+1] +== Open task assigned to me +To show all tasks belong to the member and the tasks have not set to complete. -include::../../myportal/src/docs/asciidoc/my-portal.adoc[leveloffset=+1] +== Assign an exist Task to me +To select the task in the drop down list named "Task name" for assignment the the ownself. -include::../../projectmgr/src/docs/asciidoc/project-mgr.adoc[leveloffset=+1] +== Add a new weekly Timesheet +To create a new Timesheet for user who login to the system. +== list of Timesheet +To show all Timesheet for user who login to the system. \ No newline at end of file diff --git a/scrum/src/docs/asciidoc/_include/scrum-open-test.adoc b/scrum/src/docs/asciidoc/_include/scrum-open-test.adoc new file mode 100644 index 0000000..067f308 --- /dev/null +++ b/scrum/src/docs/asciidoc/_include/scrum-open-test.adoc @@ -0,0 +1,44 @@ +//// +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +//// += Open Test +This Screen shows the list of completed backlogs that's mean all implementation tasks are set to completed. + +. Select a project you want and 'Find'. +. After result appear Click on backlog to view backlog's details +. you will see the 'How to test' field that will describe how you could test the backlog. + +You can also make an error task on the backlog's overview screen incase you found en error while you're testing. +So the backlog will be disappear from the list. + +== Open test UI +. Find Backlog +. Backlog List + +=== Find Backlog +To find the backlog which remains the task status is "test". + +=== Backlog List +On the backlog list shows + +* Sprint Name + ** click on sprint's name the action will go to sprint's overview, +* Backlog item + ** click on Backlog's name the action will go to the backlog's overview, +* Status + ** to notify the backlog's status. \ No newline at end of file diff --git a/scrum/src/docs/asciidoc/_include/scrum-product-backlog-item.adoc b/scrum/src/docs/asciidoc/_include/scrum-product-backlog-item.adoc new file mode 100644 index 0000000..33d5dee --- /dev/null +++ b/scrum/src/docs/asciidoc/_include/scrum-product-backlog-item.adoc @@ -0,0 +1,74 @@ +//// +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +//// += Product Backlog Item. +These screens includes details that need for creating new product BacklogItem and display product BacklogItem list. + + +== Product Backlog Items List +This part use to display product backlog items + +. Click at product backlog item name when user need to update it and click back button to back to previous page. + + Clicking on BacklogItem open the screen for BacklogItem Detail, so you can: + * see an overview + * update it + * associate note, content, communication +. Click delete button when user need to delete some product backlog items. + + +== Product Backlog Item Overview +On the product overview there are 8 sub menus -Overview,Update,Backlog,Billing,Default Tasks,Categories, Content,and Communications + +The product overview consist of: + +. Product Backlog Item Information +. Product Backlog Email messages +. Revisions List +. Product Backlog Item Status List: Show the Product Backlog Item Status since the Product Backlog Item have created. +. Tasks: List of task in the Product Backlog. +. E-mail: List of the E-mails that belong to Product Backlog Item. +. Backlog Item Content List: List of the E-mails that belong to Product Backlog Item. + + +== Update Product BacklogItem +This part use to update product backlog or back to previous page. + +. Enter product backlog name that user need to update. +. Select open and closed date time that user need to update for calculating work hours of product backlog. +. Click update button when insert all above fields. +. Click back button when user need to back to previous page. + + +== Add New Product Backlog Item +This part use to add new product backlog item + +. Enter product backlog item name. +. Enter priority of this product backlog item. +. Click submit button when insert all above fields. + +include::scrum-backlogItem-content.adoc[leveloffset=+1] + + +== Communication +This screen use for communication e-mails. +The screen consists of : + +. New Email Button: To create a new email. +. Product Backlog Email: To show the sending e-mail that is sent to product owner include with Subject,Status Id,Form,To and + Created. + diff --git a/docs/asciidoc/plugins-user-manual.adoc b/scrum/src/docs/asciidoc/_include/scrum-product-categories.adoc similarity index 55% copy from docs/asciidoc/plugins-user-manual.adoc copy to scrum/src/docs/asciidoc/_include/scrum-product-categories.adoc index 789622e..58c939b 100644 --- a/docs/asciidoc/plugins-user-manual.adoc +++ b/scrum/src/docs/asciidoc/_include/scrum-product-categories.adoc @@ -16,24 +16,20 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. //// -= Apache OFBiz Plugins -The Apache OFBiz Project -Release trunk -:imagesdir: ./images -ifdef::backend-pdf[] -:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] -:source-highlighter: rouge -endif::[] -:toc: -:sectnums: += Categories +== List of ProductBacklog Categories +This screen use for classification of the ProductBacklog. +The screen consists of : -include::../../birt/src/docs/asciidoc/birt.adoc[leveloffset=+1] +. New Category button +. Product Backlog Categories -include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1] +== New Categories button +To create a new categories. +When click on the button the screen appears Edit Product Backlog Category instates the Product Backlog Categories List. -include::../../ebaystore/src/docs/asciidoc/ebay-store.adoc[leveloffset=+1] - -include::../../myportal/src/docs/asciidoc/my-portal.adoc[leveloffset=+1] - -include::../../projectmgr/src/docs/asciidoc/project-mgr.adoc[leveloffset=+1] +== Product Backlog Categories +To show Product Backlog Categories List,when click it's number the screen appears Edit Product Backlog Category. +== Edit Product Backlog Category +The screen appears the criteria named "Category" to create a new category. \ No newline at end of file diff --git a/scrum/src/docs/asciidoc/_include/scrum-product-overview.adoc b/scrum/src/docs/asciidoc/_include/scrum-product-overview.adoc new file mode 100644 index 0000000..d4732cf --- /dev/null +++ b/scrum/src/docs/asciidoc/_include/scrum-product-overview.adoc @@ -0,0 +1,31 @@ +//// +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +//// += Product Overview +On the product overview there are 8 sub menus -Overview,Update,Backlog,Billing,Default Tasks,Categories, Content,and Communications + +The product overview consist of: + +. Product Information: Show the product's information. +. Backlogs Status Chart: Show backlogs' status in the pie chart concerning with open(yellow),be implement(blue),and finished(red). +. Find Product Backlog Item: To find any Product backlog which belongs to the product. +. Product Backlogs Item List: Product Backlogs Item List will show the backlogs which are not in the sprint by default. +. Emails: List of the e-mails which are sent to the product owner who created the product. +. Product Content List: List of the contents which concern to the product. +. Project and Sprint List: To show the project which concerns this product and the sprint list which belong to project. + diff --git a/scrum/src/docs/asciidoc/_include/scrum-product.adoc b/scrum/src/docs/asciidoc/_include/scrum-product.adoc new file mode 100644 index 0000000..f42e408 --- /dev/null +++ b/scrum/src/docs/asciidoc/_include/scrum-product.adoc @@ -0,0 +1,76 @@ +//// +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +//// += Product +In the Scrum component, First product owner must create or select a product to assign into project later. + +The Product Backlog is the master list of all functionality desired in the product, a Scrum team and +its product owner begin by writing down everything they can think of easily + +== Product UI +In product screen consist of. + +1. Add product button : For this button only product owner and scrum admin can see it. + + Click go to create product page +2. Find product: You can find active product. You can find by productId or product name +3. Product List: Show list active product and you can select the product to + * show an overview + * update product + * add some backlog item to your product + * ... + +include::scrum-product-overview.adoc[leveloffset=+2] + +=== Create New Product +This screen includes details that need for creating new product and display product list. + +This part use to create new product. + +. Select company name that related to product owner. +. Insert the product name and description. +. Click submit button when insert above fields. + +=== Update Product +This part use to update product. + +. The user can update product name and description. +. Click submit button when insert above fields. + +=== Product Contents +This screen use for uploading any contents that concern to the product. +The screen consists of : + +. Product Content List + * Show the list of contents by Content Type Id and Content Name. + + There are 2 buttons in each content: + .. Delete : To delete the uploaded content + .. Download : To download the uploaded content +. Add Product Content + * To upload the content. + + The content can be classified by choosing the Content Type Id and Mime Type Id. + +=== Communication +This screen use for communication e-mails. +The screen consists of : + +. New Email: To create a new email. + .. New Email: To insert the content to product owner. + .. E-mail Contents: To offer the uploading to attack the file to E-mail. +. E-mail : To show the sending e-mail that is sent to product owner include with Subject,Status Id,Form,To and Created. + + diff --git a/scrum/src/docs/asciidoc/_include/scrum-project-sprint.adoc b/scrum/src/docs/asciidoc/_include/scrum-project-sprint.adoc new file mode 100644 index 0000000..dc694ed --- /dev/null +++ b/scrum/src/docs/asciidoc/_include/scrum-project-sprint.adoc @@ -0,0 +1,132 @@ +//// +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +//// +== Project/Sprint +Now that we have a project backlog it is time to hold a project meeting. +In this project meeting discuss the goals of the project, the organization and the product backlog items and +the estimated hours to complete each item. + +Now create the project in the system and assign the members to the project with their roles. +Attach the minutes of the meeting to the project. + +=== Sprint list (and project) +The Sprint List list all the projects and for each the list of its Sprint. + +* It's possible to click on Project Name to open Project overview +* It's possible to click on Sprint Name to open Sprint overview + +=== Project +==== Create New Scrum Project +This screen includes details of Scrum project information fields that user have to be filled and then press +create button for creating new one. + +1. User can add Project Name, Description, Status, and Estimate Start Date +2. Click 'Create' button when adding finish. +3. There is project list to display relate with your project and user can update project than user created. + +==== Project Overview +This screen displays Informations of the project. +There are sprint, member and other. + +==== Project Contents +This screen use for uploading any contents that concern to the project. +The screen consists of : + +. Project Content List + * show the list of contents by Content Type Id and Content Name. + + There are 2 buttons in each content: + .. Delete : To delete the uploaded content + .. Download : To download the uploaded content +. Add Project Content + * To upload the content. + + The content can be classified by choosing the Content Type Id and Mime Type Id. + + +=== Sprint + +==== Sprint overview, Burndown Chart +Keep an eye on the burndown chart if you are still on track. +If not discuss with the product owner if backlog items have to be added or removed. + +A burn down chart is a graphical representation of work left to do versus time. + +The outstanding work (or backlog) is often on the vertical axis, with time along the horizontal. + +That is, it is a run chart of outstanding work. + +It is useful for predicting when all of the work will be completed. + +The hour burndown chart provides you with the following information: + +. Actual Hours -- The number of hours remaining until the version release date. +. Planned Hours -- The minus of the previous planned hours and the current actual hours. +. Ideal Hours -- The ideal burndown. This is computed with the remaining estimates, + not the original estimates of the hours remaining at the version's start date. +. Daily Completed -- The total time worked by the team (the current actual hours). + +==== Create the first sprint +Now that there is a project we can look at creating the (first) sprint. +Have a Sprint meeting, define what should be implemented in the (first) sprint and how it should be implemented + +Create now the (first) sprint in the system and enter also the number of backlog items which will be included in this sprint. +Attach the minutes of the meeting to the project. + +. "Add Sprint" button, press it if you want to create the sprint (Only Scrum Master can see this button). +. "List of Sprint" form, contained and display the all of sprint in the system. + +include::scrum-add-sprint.adoc[leveloffset=+3] + +==== Member +This screen includes + +* Add Sprint Backlog + . Select the Project Members Drop down list, then Role Type Id will auto appear. + . Set From date to member attack to the sprint and set Thru date to get the member out of the sprint +* print member list. + . Show the print member list.There is a Remove button for set member out of the Sprint. + +==== Add Sprint Backlog +This screen use to add product backlog item(s) that need in this sprint. + +. Enter number of product backlog item(s) that need in this sprint. +. Click submit button when insert above field. +. *product backlog item(s) that are stored in this sprint come from top of product backlog. + +==== Create tasks on the sprint backlog items +In order to be able to enter actual hours it is required to create at least a single task on every sprint backlog item. + +==== Update daily the actual and planned hours +Before going to the daily sprint meeting make sure the planned (backlog item) and actuals (tasks) are updated. + +==== Daily sprint meeting +Have a daily sprint meeting where the three famous questions are answered and enter the answers in the system related to +this sprint. + +Daily Scrum, brief, daily meetings (about 15 min) between the Scrum Master and the Scrum Team. + +The purpose is to keep work flowing smoothly and eliminate any impediments. + +There are 3 perspectives to talk in meetings : + +. What have you accomplish since the last meeting? +. What are you going to do before the next meeting? +. What problem are you having with to task? + +=== Content data +There is 3 level for uploading content. + +. Project Content +. Product Content +. Product Backlog Content diff --git a/docs/asciidoc/plugins-user-manual.adoc b/scrum/src/docs/asciidoc/_include/scrum-timeSheet.adoc similarity index 55% copy from docs/asciidoc/plugins-user-manual.adoc copy to scrum/src/docs/asciidoc/_include/scrum-timeSheet.adoc index 789622e..62e643d 100644 --- a/docs/asciidoc/plugins-user-manual.adoc +++ b/scrum/src/docs/asciidoc/_include/scrum-timeSheet.adoc @@ -16,24 +16,14 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. //// -= Apache OFBiz Plugins -The Apache OFBiz Project -Release trunk -:imagesdir: ./images -ifdef::backend-pdf[] -:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] -:source-highlighter: rouge -endif::[] -:toc: -:sectnums: += TimeSheet +== Timesheet screen consists of. +. Find TimeSheet +. Timesheet List -include::../../birt/src/docs/asciidoc/birt.adoc[leveloffset=+1] - -include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1] - -include::../../ebaystore/src/docs/asciidoc/ebay-store.adoc[leveloffset=+1] - -include::../../myportal/src/docs/asciidoc/my-portal.adoc[leveloffset=+1] - -include::../../projectmgr/src/docs/asciidoc/project-mgr.adoc[leveloffset=+1] +== Find TimeSheet +To find the required timesheet. +== Timesheet List +To show the timesheet. +There is the To Complete button for setting the timesheet. \ No newline at end of file diff --git a/scrum/src/docs/asciidoc/scrum.adoc b/scrum/src/docs/asciidoc/scrum.adoc new file mode 100644 index 0000000..377a14e --- /dev/null +++ b/scrum/src/docs/asciidoc/scrum.adoc @@ -0,0 +1,93 @@ +//// +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +//// + += The Scrum Component. +:doctype: book +:sectnums: +:toc: left +:icons: font +:experimental: +:sourcedir: . + +== Introduction + +The purpose of this component is to have a web based and ERP integrated access and recording for all information related to +your Scrum project development. + +The Scrum development methodology itself is described in any of the following documents: + +. http://www.scrum.org/scrumguides/[Scrum guide] (various languages) +. http://www.scrumalliance.org/pages/what_is_scrum[Scrum in 30 seconds.] +. http://www.softhouse.se/Uploades/Scrum_eng_webb.pdf[Scrum in 5 minutes] + +Below follows a list how the system should be used and at what time you have to update the information within the Scrum component. + + +== Administration + +include::_include/scrum-timeSheet.adoc[leveloffset=+2] + +include::_include/scrum-default-tasks.adoc[leveloffset=+2] + +include::_include/scrum-members.adoc[leveloffset=+2] + +== Product Backlog. +Before anything can start a product backlog is required which will need a product to be created first. +So create a product assign the it to a product owner which was created in the Scrum member section. +Then go to the backlog and create the backlog items. + +include::_include/scrum-product.adoc[leveloffset=+2] + +include::_include/scrum-product-backlog-item.adoc[leveloffset=+2] + +include::_include/scrum-product-categories.adoc[leveloffset=+2] + +include::_include/scrum-project-sprint.adoc[] + +include::_include/scrum-my-work.adoc[leveloffset=+1] + +== Task +The view task show Task description. + +=== View Task +. New Task button : To create new task. +. Task information. +. Sprint Backlog Item Note. +. Task Attachements. + +include::_include/scrum-open-test.adoc[leveloffset=+1] + + +== Sprint Demonstration and Evaluation meeting +At the end of a sprint demonstrate the system to the product owner and interested parties. +The product owner will incorporate comments into the current backlog list. +The team and Scrum master will evaluate the sprint so lessons can be learned for the next sprint. + +Determine also which tasks were not completed and return them to the product backlog to be included in a next sprint. + +The sprint will be repeated until the project is complete. + +== Security +In the Scrum component there are security roles to access in the Scrum component. + +1. Product Owner can create product, project, and assign member in project. +2. Scrum Master can do anything on the project. +3. Scrum admin can do anything on Scrum component +4. Scrum team can assign task to yourself and view project. + +