TEAM

TEAM Exists As Metonym | WTCC CSC 154 Group Project

https://github.com/bizzlebin/team/

***

By Jeremiah Thomas, et al

***

Created on 2020-05-24

Updated on 2020-07-23

Released on 2020-07-20

***

Copyright © Jeremiah Thomas, et al

All rights reserved.

"""THE WORK IS PROVIDED "AS IS" AND THE AUTHORS AND OWNERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS WORK INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS OR OWNERS BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS WORK."""

+++
Welcome

Welcome to the project readme for our team, tentatively named...TEAM (TEAM Exists As Metonym)! This will be our "home base" for the CSC 154 documentation project and todo list. I will try to keep most of the key information here because we have such a small group. However, as needed, I will break out some content into other files. 

Keep in mind that this is a public repo so we won't be posting any e-mail addresses, links to our other collaboration tools, etc. We'll have regular group meetings and some [emotion and thought] communication elsewhere but everything of substance should be committed here—even the meeting minutes. By doing the majority of our work in the open on Git, we will not only have better control of versioning but something we can all share in the future on a résumé; I plan to keep this repo open and public indefinitely.

+++
Schedule

===
Week 1 (2020-05-24)

---
Due By *Tuesday* (2020-05-26)

0. Read this readme.
1. Read the readme in the resources directory.
2. Set up Slack.
2.1. Create Slack account and/or join our channel.
2.2. Say hello ASAP, including your name and *GitHub username* so you can get a repo invite!
3. Set up Git.
3.1. Create Git account and/or join this repo as a collaborator.
3.2. Install Git (optional; I use plain Git (it comes with Git GUI and Git Bash) as GitHub Desktop is very so-so and a privacy/update nightmare, though the integration is tighter).
3.3. Fetch repo (optional; if you you wanted, you could theoretically do all edits from GitHub...).
3.4. Fork it (optional; if we're ok on time we may make this a requirement to tighten up the access control and learn more about GitHub).
4. Add your availability so we can schedule a regular Slack meeting (use a Git commit to the availability.txt file—get used to commits!).
5. Pick your role in roles.txt; if you want to switch with someone before Wednesday use Slack or e-mail them to discuss.
6. Add at least 2 ideas—preferably consonant with your role—to pitch_ideas.txt .

---
Due By *Thursday* (2020-05-28)

7. Make at least 1 meaningful edit to the formal pitch.txt .
8. Post at least 1 message in each Slack sub-channel associated with your role's deliverables (eg, lead dev would post in the HLD and LLD channels).
9. Create [deliverable abbreviation]_ideas.txt file in the root directory for each deliverable you are the primary responsible party for (eg, srs_ideas.txt for the customer advocate; note that some of you will not need to create anything); please make sure you use the proper NKMF headers in your text document, use proper UEWSG-style formatting and syntax, and pay attention to the commit messages: they are easy to write from Git GUI or Git Bash and should follow the format I've outlined—if the message doesn't meet the requirements, I will undo your push and you can try the commit/push again (you'll have to rebase).

---
Due By *Saturday* (2020-05-30)

10. Copyedit of final Pitch document (document specialist only; we're still awaiting *substantive* information from the teacher about filetype and other reqs).

===
Week 2 (2020-05-31)

---
Due By Tuesday (2020-06-02)

1. SRS Ideas work (add directly to text file).
1.1. Propose at least 1 business requirement (SRS 3; please keep it to clear but concise bullet points as far as possible).
1.2. Propose at least 1 functional requirement (SRS 4).
1.3. Propose at least 1 non-functional requirement (SRS 5).
1.4. Propose at least 1 interface requirement (SRS "6" (numbering is borked)).
1.5. Propose at least 1 performance requirement (SRS "7").
2. HLD Ideas work (add directly to text file).
2.1. Propose at least 1 design issue (HLD 2.2).
2.2. Propose at least 1 security design detail (HLD 3.1).
2.3. Propose at least 1 UI design detail (HLD 3.3).
2.4. Propose at least 1 internal interface design detail (HLD 3.4).
2.5. Propose at least 1 external interface design detail (HLD 3.5).
3. Meeting prep.
3.1. Prepare your personal agenda (applies to every meeting; keep it short and view the meeting format spec for hints).
3.2. E-mail PM any agenda/vote items (applies to every meeting).
3.3. DB vote: research and choose top DB out of SQLite, Postgres, and MariaDB (vote during meeting).
3.4. Person #6 expulsion vote: still no contact as of Sunday evening (vote during meeting).

---
Due By Thursday (2020-06-04)

4. Client: clean up file, add more information (CA only).
5. Design Overview: create very-high-level conceptual drawing (LSD only; consider SVG or other vector format or just scan a drawing).
6. Tests: pick at least 5 types of tests and write a short paragraph detailing why each will help the app succeed (LT only).
7. Requirements: create traceability matrix from all proposed SRS requirements (DS only; find a tabular method that is comprehensive and suitable for plaintext, whittling down any fields we don't need).
8. SRS: complete Intro (1) and General Description (2) (CA only; formal, in /docs).
9. HLD: complete Intro (1) (LSD only; formal, in /docs).
10. Meeting prep.

---
Due By Saturday (2020-06-06)

11. Task List: add exactly *3* items.
12. Glossary: add at least *3* items.
13. Check formatting on all documents (DS only).

===
Week 3 (2020-06-07)

---
Due By Tuesday (2020-06-09)

1. SRS (CA only).
1.1. Pick at least 20 requirements spanning the required categories (read SRS spec for list).
1.2. Describe each requirement clearly in 1 sentence.
1.3. Create M[o]SC[o]W for requirements.
1.4. Add paragraph describing how we used the collaboration tool categories (new division: 2.4).
2. HLD (LSD and LT only).
2.1. Settle on base classes and/or functions for entire project (division 3.10).
2.2. Add paragraph describing how we used the collaboration tool categories (add to division 2.3).
3. UI wireframe or mockup (LUID only).
4. First user story (DS only).
5. Meeting prep.
5.1. Vote on which leg of hierarchy to use for LLD.

---
Due By Thursday (2020-06-11)

6. First use case (DS only).
7. Sequence diagram for 1 SRS req (LUID only).
8. LLD.
8.1. Add 1 class idea to LLD Ideas.
8.2. Add DB information to LLD Ideas (LT only).
9. Link all requirements to at least 1 business requirement (CA only).
10. Meeting prep.

---
Due By Saturday (2020-06-13)

11. Complete General Description division (CA only; SRS 2).
12. Procedures For Project Requirement Changes (PM only; SRS 11.2).
13. First HLD UML diagram (LUID only).
14. Pick and list all classes in LLD ideas (LT only).
15. Check formatting on all documents (DS only).

===
Week 4 (2020-06-14)

---
Due By Tuesday (2020-06-16)

1. Make at least 3 constructive comments, in the appropriate channel, about a deliverable you are not the primary responsible party for.
2. Cleanup of SRS Draft: all divisions fixed, full paragraph descriptions where appropriate, etc (CA only).
3. SRS diagrams.
3.1. Create 2 sequence diagrams for SRS (LT only).
3.2. Create 2 UML diagrams for SRS (LUID only).
4. HLD (LSD, LUID only).
4.1. Finish design summary (HLD 2).
4.2. Add security and hardware divisions (HLD 3.1, 3.2).
4.3. Add UI division (HLD 3.3).
4.4. Add architecture division (HLD 3.6).
4.5. Finish describing/diagramming all class info (HLD 3.10).
5. Finish LLD *Final* template [in plaintext] (LSD, LT only).
6. Meeting prep.

---
Due By Thursday (2020-06-18)

7. Add at least 3 ideas of LLD ideas, based upon our template.
8. Copyedit of SRS Draft [in plaintext] (DS only).
9. Second HLD UML diagram (LUID only).
10. Begin adding test procedures, info to LLD (LT only).
11. Meeting prep.

---
Due By Saturday (2020-06-20)

12. Template SRS Draft, including all graphics (DS only).
13. HLD (LSD, LUID only).
13.1. Add internal and external interfaces (HLD 3.4, 3.5).
13.2. Add reports (HLD 3.7).
13.3. Add database (HLD 3.9).
13.4. Add data flow diagram (HLD 3.12).
14. LLD (LSD, LT only).
14.1. Add general DB info.
14.2. Add DB tables (incl PKs and linking table(s)) and relationships.
14.3. Add any other DB access controls, restrictions, etc.
15. Check formatting on all documents *and* reach out to anyone who is still having trouble with commit messages (DS only).

===
Week 5 (2020-06-21)

---
Due By Tuesday (2020-06-23)

1. Comment on at least 1 thing you like about our formal SRS Draft in #srs and 1 thing you might improve.
2. Meeting prep.
2.1. Group activity: roundtable: what is your biggest concern with current state of the HLD?

---
Due By Thursday (2020-06-25)

3. Update task list with at least *1* more post-LLD item and with *all* times (in hours, rounded down to nearest hour (0 is fine)) for tasks you were the primary responsible party for; include only time *you* spent.
4. Create SRS Final in docs/ (CA only; copy over SRS Draft).
5. HLD (LSD, LUID, and LT).
5.1. Add Configuration Data (HLD 3.11).
5.2. Finish Design Summary (HLD 2).
5.3. Finish all draft graphics (1+ structure and 1+ behavior UML).
5.4. Cleanup of HLD Draft: all divisions fixed, full paragraph descriptions where appropriate, etc.
6. Meeting prep.
6.1. Group activity: roundtable: what did we learn from the SRS feedback?

---
Due By Saturday (2020-06-27)

7. Copyedit of HLD Draft [in plaintext] (DS only).
8. LLD (LSD, LT only).
8.1. Finish Introduction (LLD 1).
8.2. Finish Database Design (LLD 3).
8.2.1. Add ER diagram (LLD 3.2).
8.2.2. Add pseudocode for database access (LLD 3.1).
8.2.3. Add information on how the DB uses 3rd normal form (LLD 3.2).
9. Reorder all SRS requirements in terms of importance (CA only).
10. Check formatting on all documents *and* reach out to anyone who is still having trouble with any formatting (DS only).

===
Week 6 (2020-06-28)

---
Due By Tuesday (2020-06-30)

1. Template HLD Draft, including all graphics (DS only).
2. LLD (LSD, LT only).
2.1. Add pseudocode for classes (LLD 2.1).
2.2. Add pseudocode for all other needed items (LLD 2).
3. Meeting prep.
3.1. Group activity: roundtable: what are your concerns with current state of the LLD?

---
Due By Thursday (2020-07-02)

4. Create HLD Final in docs/ (LSD only; copy over HLD Draft).
5. Cleanup of LLD: all divisions fixed, full paragraph descriptions where appropriate, etc (LSD, LT only).
6. SRS (CA only).
6.1. Get below 20 requirements.
6.2. Add requirements for divisions that don't have them (eg, 5.1.2) or describe why.
6.3. Address any teacher feedback.
7. Meeting prep.

---
Due By Saturday (2020-07-04)

8. Copyedit of LLD Draft [in plaintext] (DS only).
9. First draft of SRS requirements traceability matrix (LT only).
10. Check formatting on all documents *and* reach out to anyone who is still having trouble with any formatting (DS only).

===
Week 7 (2020-07-05)

---
Due By Tuesday (2020-07-07)

1. Template LLD, including all graphics (DS only).
2. SRS (CA only).
2.1. Validate all requirements meet the 5 Ws and H; create change requests to address shortcomings.
2.2. Use consistent language, including "must", in all requirements.
3. HLD *Final* (LSD, LT only).
3.1. Add all Python modules (HLD 2.4).
3.2. Update chapters 1 and 2 to reflect LLD and SRS and for flow/quality.
4. Meeting prep.

---
Due By Thursday (2020-07-09)

5. Read LLD to familiarize yourself with it and look for inconsistencies with HLD, SRS.
6. SRS (CA only).
6.1. Reorder all M[o]SC[o]W divisions by priority (change numbering).
6.2. Reorder main reqs by priority, division by division (do not change numbering).
7. Meeting prep.
7.1. Group activity: roundtable: what did you notice from the LLD?

---
Due By Saturday (2020-07-11)

8. SRS.
8.1. Link all functional requirements to at least 1 business requirement (CA only).
8.2. Link all non-functional requirements to at least 1 functional requirement (CA only).
8.3. Finish project schedule (PM only).
9. HLD (LSD, LT only).
9.1. Update chapter 3 to reflect LLD.
9.2. Add reports section (HLD 3.7).
9.3. Add other output section (HLD 3.8).
10. Check formatting on all documents, *including* CR + LF and encoding issues (DS only).

===
Week 8 (2020-07-12)

---
Due By Tuesday (2020-07-14)

1. SRS.
2.1. Cleanup of SRS: all additions and edits for quality must be complete; this includes a *cover to cover* review (CA only).
2.2. Graphics check: all graphics must match current state of SRS, HLD, and LLD (DS only).
2.3. Finish V&V (LT only; SRS 11.5).
3. HLD (LSD, LT only).
3.1. Cleanup of HLD: all additions and edits for quality must be complete; this includes a *cover to cover* review.
3.2. Graphics check: all graphics must match current state of SRS, HLD, and LLD.
3.3. Class check: all top-level classes must be fully described, including core methods.
4. Meeting prep.
4.1. Final regular CCB session.

---
Due By Thursday (2020-07-16)

5. Copyedit of SRS [in plaintext] (DS only).
6. Copyedit of HLD [in plaintext] (DS only).
7. Meeting prep.
7.1. Group activity: roundtable: do you have any final suggestions or concerns with the project?

---
Due By Saturday (2020-07-18)

8. Template SRS, including all graphics (DS only).
8.1. Sign the "High-Level Design Document Review History" for version 2 (CA, DS only).
9. Template HLD, including all graphics (DS only).
9.1. Sign the "Requirements Document Review History" for version 2 (LSD, LT, and DS only).

===
Week 9 (2020-07-19)

---
Due By *Monday* (2020-07-20)

1. Sign the SRS "Review And Approval" for version 2 (CA, DS, PM only).
2. Sign the HLD "Review And Approval" for version 2 (LSD, DS, PM only).

---
Due By Tuesday (2020-07-21)

3. Meeting prep.
3.1. Final presentations.
3.2. Group activity: FFA project retrospective!

---
Due By Thursday (2020-07-23)

4. Meeting prep.
4.1. Group activity: optional photo.
4.3. Group activity: discuss end-of project dinner.
4.3. Group activity: goodbyes!
5. Archive repository (PM only).

+++
Ground Rules

For now, because the group is so small, I am going to give everyone commit privileges. Regardless, here are the rules we'll be observing:

1. Respect others.
2. Respect others's work.
3. Respect the group roles and hierarchy.
4. Respect the project and goals.
5. Respect everyone's time—including your own.

+++
Metametadata

**meta_title**: Readme
**meta_uri**: https://github.com/bizzlebin/team/readme.txt
**meta_author**: Jeremiah Thomas
**meta_generator**: Notepad++
**meta_created**: 2020-05-24
**meta_updated**: 2020-07-14