Project → v1.0 [week 5]

Overview: conceptualize product and document it as a user guide(draft), draft a rough project plan

v1.0 Summary of Milestone

Here is a summary of items you need to deliver to reach v1.1 individual () and team () milestones. See sections below for more details of each item.

❗️ Reaching individual and team milestones are considered for grading the project management component of your project grade (expand the panel below for more info).

❗️ The deadline for reaching a milestone is the midnight before your tutorial e.g., if your tutorial is on Wednesday, you need to reach the milestone by Tuesday midnight.

v1.0 Documentation

• Developer Guide: Have a draft of the requirements of your project, as described in mid-v1.0 progress guide.

• User Guide:
  Draft a user guide in a convenient format (e.g., a GoogleDoc) to describe what the product would be like when it is at 2.0. We recommend that you follow the existing AB4 User Guide in terms of structure and format.

  💡 It is highly recommended that you divide documentation work (in the User Guide and the Developer Guide) among team members based on enhancements/features each person would be adding  e.g., If you are the person planing to add a feature X, you should be the person to describe the feature X in the User Guide and in the Developer Guide. For features that are not planned to be implemented by v1.4, you can divide them based on who will be implementing them if the project were to continue until v2.0 (hypothetically).

  Reason: In the final project evaluation your documentation skills will be graded based on sections of the User/Developer Guide you have written.

Suggested length: Follow the existing user guide and developer guides in terms of the level of details.

Submission: Save your draft a single pdf file, name it {Your Team ID}.pdf e.g., W09-3.pdf and upload to IVLE.

v1.0 Project Management

• After the v2.0 is conceptualized, decide which features each member will do by v1.4. We realize that it will be hard for you to estimate the effort required for each feature as you are not familiar with the code base. Nevertheless, come up with a project plan as per your best estimate; this plan can be revised at later stages. It is better to start with some plan rather than no plan at all. If in doubt, choose to do less than more; we don't expect you to deliver a lot of big features.
• Divide each of those features into three increments, to be released at v1.1, v1.2, v1.3 (v1.4 omitted deliberately as a buffer). Ideally, each increment should deliver a end-user testable enhancement.
• Document the above two items somewhere e.g., in a Google doc/sheet

Submission: Include in the pdf file you upload to IVLE.