Skip to content

Commit bfbc60a

Browse files
committed
documentation
1 parent 4d83df1 commit bfbc60a

11 files changed

Lines changed: 168 additions & 62 deletions

File tree

logo.png

103 KB
Loading

product_research/README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
1-
Product & Research
2-
---
1+
# PyGuard
2+
3+
![Team Logo](./logo.png)
4+
5+
#### Team Slack Channel: #team\-\<your\-company\-name\-here\>
36

4-
This folder contains content and research about our product, including market research, product feedback, and user exploration.
7+
COMPANY NAME is a company founded in the THEME industry. COMPANY NAME aims to VISION STATEMENT.
58

69
Table of Contents
710
---
811

9-
- [Market](./market.md)
10-
- [Roadmap](./roadmap.md)
12+
- [People](./team/)
13+
- [Diversity](./team/diversity.md)
14+
- [Product & Research](./product_research/)
15+
- [Market](./product_research/market.md)
16+
- [Roadmap](./product_research/roadmap.md)

team/diversity.md

Lines changed: 47 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,52 @@
1-
Diversity
2-
---
1+
# Diversity
32

4-
Diversity is ... Intro Statement
3+
## Intro Statement
4+
- Combining technical expertise with diverse global perspectives
5+
- Leveraging international backgrounds (aka Morocco + China) to build better software
6+
- Committed to identifying and bridging our experience gaps
57

6-
7-
Team Background
8-
---
9-
10-
Our team has a varied background. We have people from multiple continents who speak many languages combined....
8+
## Team Background
9+
- **Yunling**: Roots in China, international student in Canada
10+
- **Malek**: Roots in Morocco, moved to Canada for university
11+
- **Global Reach**: Experience with Eastern Asian, North African, North American (but not too expereinced yet)
12+
- **Languages**: Multilingual team with varied life experiences (Chinese, Arabic)
1113

1214
## Strengths & Weaknesses
1315

14-
Our team has....
15-
16-
### Subject Matter Experts
17-
18-
Subject matter experts (SMEs) who can help us address our expertise gaps are...
19-
20-
## Diversity
21-
22-
Our team has a varied background, but we acknowledge that we do not have people experienced in/who are....
23-
24-
### How this can impact us
25-
26-
A potential impact of this is...
27-
28-
People with backgrounds that differ from out own can help us in the THEME industry because...
16+
### Strengths
17+
- **Tech Stack**: Python, Java, C++, PyTorch, TensorFlow
18+
- **Hardware**: PCB design, Arduino, 3D printing
19+
- **Domain Knowledge**: AI/ML, NLP, Computer Vision, Applied Health Science
20+
- **Psychology**: Understanding user behavior and cognition
21+
- **Design Philosophy**: Focus on software-based solutions and automation
22+
23+
### Weaknesses (Gaps)
24+
- Limited experience with long-term system maintenance
25+
- Lack of hands-on telecom customer data exposure
26+
- Unfamiliar with specific telecom regulations
27+
- Limited experience designing for non-technical populations
28+
29+
## Subject Matter Experts (SMEs)
30+
- **MLOps Specialist**: For system reliability, monitoring, and scalability
31+
- **Telecom Specialist**: Insights into real workflows and data constraints
32+
- **Privacy/Compliance Expert**: Guidance on regulations and data protection
33+
- **Cross-cultural UX Specialist**: To avoid cultural bias in design
34+
- **AI Ethics Specialist**: To identify potential misuse or harm
35+
36+
## Diversity Gaps
37+
- No lived experience with physical or sensory disabilities
38+
- Limited exposure to older user demographics
39+
- Limited representation of religious diversity
40+
- Lack of experience with marginalized communities
41+
42+
## How this can impact us
43+
- **Assumptions**: Risk of assuming all users are tech-savvy
44+
- **Design**: Potential to overlook accessibility needs (visual/motor)
45+
- **Communication**: Might miss cultural nuances in language support
46+
- **Ethics**: Could underestimate risks for vulnerable user groups
47+
48+
## Value of Different Backgrounds
49+
- Challenge our default technical assumptions
50+
- Highlight accessibility barriers we might not see
51+
- Ensure product relevance across different cultures
52+
- Help navigate complex ethical and regulatory landscapes

team/generic_woman.jpg

-23.8 KB
Binary file not shown.

team/jane_doe.md

Lines changed: 0 additions & 30 deletions
This file was deleted.

team/malek_sibai.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Malek Sibai
2+
3+
![Malek Sibai Profile](./malek_sibai_image.png)
4+
5+
- Machine Learning Engineer
6+
- malek.sibai@mail.utoronto.ca
7+
8+
## Links
9+
10+
- [GitHub](https://github.com/malek72)
11+
- [LinkedIn](https://www.linkedin.com/feed/)
12+
13+
## About Malek
14+
15+
Malek is from Morocco where he has experience as a Machine Learning Engineer. He has also worked in software developer work. He moved from Morocco to Canada when she was 18. In his spare time he loves playing soccer and going out with friends.
16+
17+
## Strengths
18+
19+
- Time Management
20+
- Organized
21+
- Curious
22+
23+
## Weaknesses
24+
25+
- Reading
26+
- Spending too much screen time
27+
- AFCON Final Victim

team/malek_sibai_image.png

212 KB
Loading

team/principles.md

Lines changed: 55 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,56 @@
1-
The team principles doc is a roughly 1-page doc that covers: expectations of the team members, expectations for communication, roles and responsibilities, work delegation, etc.
2-
The document will cover the entire team including CSC454/2527 students.
3-
An example can be found [here](https://csc491.dcsil.ca/assignments/a1_example/).
1+
Below is our team principles document:
42

5-
Optionally, team values can also be described. A real-world example of company values can be found [here](https://www.getdbt.com/about-us/values).
3+
# Team Principles
4+
5+
## Communication:
6+
7+
* Team members will mainly communicate using a private slack channel: #PYGUARD.
8+
* The purpose of this channel will be to confirm meetings, handle assignment questions and remind people to complete tasks.
9+
* It will be the responsibility of the person asking the question to tag the people they are asking specifically.
10+
* General questions can be posed to the group at large.
11+
* While not strictly necessary, it will be seen as good etiquette to acknowledge important questions and answers by using thumbs up/down reactions to these messages.
12+
* We expect everyone to check the group at least once a day (Monday to Friday). If there is a reason you cannot check the group for longer than 1 day, you are expected to inform the team so we know not to expect a response.
13+
* Emergencies: In case of emergency, we have the group's collected phone numbers pinned in a slack channel for texting and calling. This channel of communication is meant only for specific and rare cases.
14+
* Our primary goal with these expectations for communications is to promote a positive, cohesive, blameless culture within our group.
15+
16+
**We are all here to support each other. We are a TEAM! Not just a group.**
17+
18+
## Meetings:
19+
20+
* We will hold regular meetings for our team members, every Wednesday at 6pm.
21+
* Members are responsible for attending the team meetings – if they are not able to make it, they must let the other attendees know as soon as possible.
22+
* They must then make a plan to compensate for their absence. This could involve having someone present replace their role in the meeting or deliver an update on their behalf, and would also involves catching up on meeting contents to understand what new tasks they have.
23+
24+
## Work:
25+
26+
* We are all there to support each other on the work involved for this course.
27+
* We will try our best to delegate work evenly during our team meetings. This delegated work will be recorded on GitHub issues.
28+
* If something comes up, or the work is proving to be more time consuming and difficult than anticipated, then members are expected to let the team know. They will be able to help out.
29+
* Team members are expected to also complete work with a reasonable amount of time for the other members to review and discuss (can use pull requests and tags in issue comments to coordinate this). This means that last minute submissions of work are not ideal, since it is difficult to do this.
30+
31+
## Conflict & Decisions:
32+
33+
* Disagreements are expected and will be handled respectfully and professionally.
34+
* Team members should first discuss differing viewpoints openly in the Slack channel or during meetings, focusing on ideas rather than individuals.
35+
* We will prioritize decisions based on project requirements, evidence, and team consensus.
36+
* If consensus cannot be reached, the team will vote or defer to the person most responsible for that area of work.
37+
* Once a decision is made, all members are expected to support it and move forward constructively.
38+
39+
## Accountability:
40+
41+
* Team members are expected to honour their commitments and deadlines.
42+
* If someone misses a commitment, they should communicate the reason as soon as possible.
43+
* The team will work together to adjust timelines or redistribute tasks when needed.
44+
* Repeated missed commitments without communication will be addressed through a direct and respectful conversation to identify issues and agree on improvements.
45+
* The goal of accountability is support and reliability, not blame.
46+
47+
## Feedback:
48+
49+
* Feedback will be honest, respectful, and focused on improving the work rather than criticizing individuals.
50+
* Constructive feedback should be specific, actionable, and given in a timely manner (e.g., via pull request comments or meetings).
51+
* Team members are encouraged to ask for feedback early to avoid last-minute issues.
52+
* Everyone is expected to be open to receiving feedback and to view it as part of learning and collaboration.
53+
54+
## Other issues:
55+
56+
* We cannot foresee every kind of issue that might arise; however, the team is committed to coming up with a plan to overcome roadblocks of any kind through shared communication on how to handle the issue.

team/tooling.md

Whitespace-only changes.

team/yunling_zhang.jpeg

149 KB
Loading

0 commit comments

Comments
 (0)