-
Notifications
You must be signed in to change notification settings - Fork 903
Technical Design sessions
Nok Lam Chan edited this page Aug 4, 2023
·
3 revisions
- Introduction to the problem (5 minutes)
- Additional context (5 minutes)
- Clarification questions (not going into solution yet) (10 minutes)
- Introduction to suggested solution (5 minutes)
- Discussion on solution + alternatives (also ask questions if things aren't clear) (20 minutes)
- Final questions (5 minutes)
- Summary & next steps (5 minutes)
- Create specific TD tags for Github issues to specify topics (e.g., implementation discussion, user research summary, learning session). @Merel to ask for a topic every Thursday, if there’s none by Friday the meeting will be cancelled.
- Tech Design is “bookable” through project board https://github.com/orgs/kedro-org/projects/2/views/19, just move your topic to the Next Up column for it to be discussed.
- Prepared Topic Discussion and Decision Record (DR):
- The ideal tech design session involves discussing a topic that has been prepared in advance.
- Everyone in the meeting gets a chance to speak and contribute their ideas.
- Clear decisions are recorded and not revisited unless new data or information emerges.
- Diverse and Adaptable Meeting Formats:
- The weekly technical design session should be a slot that people can book for various purposes.
- These purposes may include sharing and discussing user research with the entire team, brainstorming solutions with engineers and other interested parties, and understanding aspects of the codebase with engineers.
- Consider diversifying the meeting formats to address different needs and make attendance expectations more ad-hoc.
- Clarity on Discussion Topics:
- Ensure there’s clarity on the topic to be discussed in the session and what is expected from the discussion (e.g., implementing a specific feature, summarising user research, or making a decision on a certain matter).
- Consider using tags on tickets to indicate the purpose of the discussion.
- Engagement Tools and Voluntary Participation:
- Use collaborative tools like digital whiteboards or online polling during the sessions to increase engagement and participation.
- Implement silent brainstorming, where participants write down their ideas before sharing them aloud.
- It’s essential to create an environment where nobody is forced to participate, and some attendees may choose to listen and learn without actively contributing.
- Decision Record: summarise the discussion on the Github issue and create follow up issues if needed. Example: https://github.com/kedro-org/kedro/issues/1828#issuecomment-1309020983
- Avoid revisiting decisions unless new data arises. Format of discussion is up to the session leader, but interactivity is encouraged (e.g., timers, Miro, polls, digital whiteboards). The person who’s leading the topic should provide as much context as possible in advance and the people who intend to attend the meeting, should come prepared and ask questions in advance of the meeting as well so the 1 hour can be used to the fullest.
- People who intend to attend the meeting, should come prepared and ask questions in advance of the meeting as well so the 1 hour can be used to the fullest.
- Contribute to Kedro
- Guidelines for contributing developers
- Contribute changes to Kedro that are tested on Databricks
- Backwards compatibility and breaking changes
- Contribute to the Kedro documentation
- Kedro documentation style guide
- Creating developer documentation
- Kedro new project creation - how it works
- The CI Setup: GitHub Actions
- The Performance Test Setup: Airspeed Velocity
- Kedro Framework team norms & ways of working ⭐️
- Kedro Framework Pull Request and Review team norms ✍️