Week 7 [Fri, Feb 19th] - Project

On a somewhat related note, you can also create similar product websites for your other projects (projects from other modules, pet projects).

• To get some practice of doing project iterations, do this week's tP work (i.e., updates to various documents) as if it is a project iteration that will reach a milestone v1.1, as explained in the pane below.

• Don't forget to 'wrap up' the milestone at the end of this week (as explained in the panel above), after the work is done.

• AboutUs page: This page (in the /docs folder) is used for module admin purposes. Please follow the format closely or else our scripts will not be able to give credit for your work.
  • Add your own details. Include a suitable photo as described here.
  • Including the the supervisor/lecturer is optional.
  • The filename of the profile photo should be docs/images/githbub_username_in_lower_case.png
    Note the need for lower case (GitHub usernames are not case sensitive, but URLs in GitHub-pages are -- to avoid any mismatches, we have fixed the file name here to be lower casewhy lowercase?) e.g. JohnDoe123 -> docs/images/johndoe123.png not docs/images/JohnDoe123.png.
    If your photo is in jpg format, name the file as .png anyway.
  • Indicate the different roles played and responsibilities held by each team member. You can reassign these roles and responsibilities (as explained in Admin Project Scope) later in the project, if necessary.

• README page: Update it to match your project.

  • Add a UI mockup of your intended final product. Note that the image of the UI should be docs/images/Ui.png so that it can be downloaded by our scripts. Limit the file to contain one screenshot/mockup only and ensure the new image is roughly the same height x width proportions as the original one. Reason: when we compile these images from all teams into one page (example), yours should not look out of place.
    If you did the above update correctly, UI mock up and profile photos should appear in your project website and this Project List Page.

  • Update all contents to match your own project.

  • Update the link of the GitHub Actions build status badge () so that it reflects the build status of your team repo.

  • Acknowledge the original source of the code e.g.,
    This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

• Update site-wide settings as described in the guide Using Jekyll for project documentation @SE-EDU/guides.

• Move the draft UG content into the User Guide page in your repository. Update the content as necessary. If a feature is not implemented in the current version, you can either omit it from the UG or mark it as 'Coming soon' (e.g., ## Archiving contacts [coming soon]).
  As mentioned before, while it is more convenient for one person to update the entire UG, we recommend that each person updates their own part of the docs so that we can easily track the contribution of each member using RepoSense.

• Add the following to the DG, based on your project notes from the previous weeks.
  Some examples of these can be found in the AB3 Developer Guide.

  • Target user profile, value proposition, and user stories: Update the target user profile and value proposition to match the project direction you have selected. Give a list of the user stories (and update/delete existing ones, if applicable), including priorities. This can include user stories considered but will not be included in the final product.
  • Use cases: Give use cases (textual form) for a few representative user stories that need multiple steps to complete. e.g. Adding a tag to a person (assume the user needs to find the person first)
  • Non-functional requirements: Note: Many of the given project constraints can be considered NFRs. You can add more. e.g. performance requirements, usability requirements, scalability requirements, etc.
  • Glossary: Define terms that are worth recording.

• Plan the next iteration. As you know, you should follow the breadth-first iterative process. Therefore, first you must decide what functionalities should be in the product if you had only two weeks to implement it. You have done that already when you chose user stories for v1.2, translated that to features, and even drafted the UG based on those features. You can tweak that plan further at this point if you wish, given that you now have some idea of how fast the team can work when using the prescribed workflow.
  • Aim to produce a working MVP at the end of this iteration even if the functionalities are not polished (polishing can be done in a later iteration).
  • If possible, break the iteration into two increments i.e., aim to produce an even simpler but working version after one week.
  • Avoid depth-first implementations: "I'll do the back-end part of feature X in this iteration" is not acceptable as that is not in the spirit of iterative development. Remember, we are pretending this to be the last iteration; why would you implement the back-end part of a feature in the last iteration?
    It is OK to add simpler versions of bigger features, but not OK to add partial features that can't be used yet.
• Divide the work among the team members i.e., the work required for the current iteration.
• Reflect the above plan in the issue tracker by assigning the corresponding issues (create new issues if necessary) to yourself and to the corresponding milestone. For example, the user story pertaining to the increment show a place holder for photo, showing a generic default image should be assigned to Jake and to milestone v1.2
  Optionally, you can define a mid-v1.2 milestone to keep track of things to be done within the first half of the milestone.

• If you have time, start implementing v1.2.