Skip to content

Commit

Permalink
Robel notes included
Browse files Browse the repository at this point in the history
  • Loading branch information
TekaMesfinAbel committed Jan 8, 2025
1 parent f3bdf87 commit 85af921
Showing 1 changed file with 111 additions and 0 deletions.
111 changes: 111 additions & 0 deletions notes/First meeting note.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
# Group Task: Writing and Reviewing Explanations

## Meeting Overview

During our meeting, we were tasked with reviewing and practicing documentation writing. To ensure an organized approach, we followed a structured process. Here's how we proceeded

---

## Writing Explanations

1. **Select a Topic:**
- Choose a topic from the list below.
- Mark your selected topic with `[ ]` in the checkbox next to it.
2. **Claim Your Topic:**
- Create a comment on your topic's line.
- Write your name at the top of the comment so everyone knows who is working on which explanation.
3. **Write the Explanation:**
- Include the following details in your comment:
- **What is it?**
- **How is it used?**
- **What collaboration challenges does it address?**
4. **Indicate Completion:**
- When your explanation is complete, update the checkbox to `[O]` to signal it's ready for review.
5. **Repeat the Process:**
- If all topics marked `[O]` are under review, select a new topic and write another explanation.

---

## Reviewing Explanations

1. **Select an Explanation to Review:**
- Find a topic marked `[O]` for review.
2. **Claim the Review Task:**
- Update the checkbox to `[...O]` and add a comment with your name, indicating you are reviewing this explanation.
3. **Perform the Review:**
- Check the explanation for:
- Accuracy and clarity.
- Correct spelling and grammar (use [Grammar Check](https://www.grammarcheck.net/editor/)).
- Discuss any questions or improvements with the author in the comment.
4. **Finalize and Document:**
- Once the explanation is ready, copy-paste it into the main document ("Things Explained") under a Level 2 heading.
- Mark the checkbox with `[X]` to indicate completion.

---

## Proofreading the Document

1. **Collaborative Proofreading:**
- Once all explanations are added to the main document, proofread it as a group.
2. **Discussion:**
- Reflect on the writing process and ensure:
- Every topic from the list is included in the document.
- Each explanation makes sense to the entire group.

---

## Stand-Up Questions

Be prepared to answer the following questions during the main group call:

- What went well?
- What went less well?
- What did you learn as a group?

---

## Challenges in Collaborative Writing

- Shared Understanding
- Communication
- Task Division
- Task Tracking
- Proofreading
- Reassembling
- Merge Conflicts
- Backtracking

---

## Topics to Explain

For each item, write a short explanation covering:

- **What it is.**
- **How it’s used.**
- **Which collaboration challenges it helps address.**

### Topic List

- [X] Project Methodologies (Agile, Scrum, …)
- [X] Command Line Interface / Terminal
- [X] Git
- [X] GitHub
- [X] GitHub Repository
- [O] GitHub Issues
- [O] Project Boards
- [X] Pull Requests
- [ ] Continuous Integration (CI)
- [O] Code Review

---

## Things Explained

(Insert completed explanations here.)

---

## How We Completed the Task

To complete the task effectively, we divided the topics among group members and prepared the explanations accordingly. Each member followed the above steps to write, review, and finalize the explanations.

0 comments on commit 85af921

Please sign in to comment.