From bd5063c54a890a68bff9029819c382c772d2776b Mon Sep 17 00:00:00 2001 From: John Moravec <51122406+educationfutures@users.noreply.github.com> Date: Mon, 15 Jan 2024 13:14:02 -0600 Subject: [PATCH] initial fixes to text --- docs/admin/accessing.md | 14 +-- docs/admin/basic-usage/navigating.md | 36 +++--- docs/admin/sidebar-items/dashboard.md | 18 +-- docs/admin/sidebar-items/data.md | 105 ++++++++---------- docs/admin/sidebar-items/questionnary.md | 88 +++++++-------- docs/app/basic-usage/configuring-device.md | 42 ++++--- docs/app/basic-usage/creating-account.md | 25 ++--- docs/app/basic-usage/discovering-home.md | 98 ++++++++-------- docs/app/class-observation/about-lesson.md | 12 +- docs/app/class-observation/how-to-start.md | 34 +++--- .../class-observation/rating-competences.md | 31 +++--- docs/app/coaching-process/how-to-start.md | 30 ++--- .../coaching-process/performing-a-feedback.md | 24 ++-- docs/app/community-of-practice.md | 60 +++++----- docs/app/installation.md | 70 ++++++------ docs/app/teachers-data/about-teachers-data.md | 16 ++- docs/app/teachers-data/previous-sessions.md | 34 +++--- docs/app/teachers-data/statistics.md | 55 ++++----- docs/app/terminologies.md | 43 +++---- docs/code/intro.md | 20 ++-- 20 files changed, 410 insertions(+), 445 deletions(-) diff --git a/docs/admin/accessing.md b/docs/admin/accessing.md index 2066ef7..2198424 100644 --- a/docs/admin/accessing.md +++ b/docs/admin/accessing.md @@ -2,19 +2,19 @@ sidebar_position: 0 --- -# About the application +# About the Application -The Admin Panel is the system used by the government and people responsible for managing data and information on the Coach Digital app. It is possible: +The Admin Panel serves as a vital tool for government officials and designated individuals in managing data and information within the Coach Digital app. It offers the following capabilities: -- View data from sessions that Coaches held with teachers -- View local, regional and national performance data* -- Create and edit Teaching Practices used by Coaches to evaluate teachers in the coaching process +- Viewing data from sessions conducted by Coaches with teachers. +- Accessing performance data at local, regional, and national levels*. +- Creating and editing Teaching Practices that Coaches use to assess teachers during the coaching process. -**Data region preview availability depends on user permission.* +*Note: The availability of data previews for different regions is subject to user permissions.* ## Getting Started -To start using, access the [Admin Panel](https://coachdigital.org/np/admin/) website and enter your registered username and password. +To begin utilizing the Admin Panel, visit the [Admin Panel website](https://coachdigital.org/np/admin/) and sign in using your registered username and password. ![Login page](/img/admin_getting_started/admin-login.png) diff --git a/docs/admin/basic-usage/navigating.md b/docs/admin/basic-usage/navigating.md index 8cb1e10..e88df9d 100644 --- a/docs/admin/basic-usage/navigating.md +++ b/docs/admin/basic-usage/navigating.md @@ -2,41 +2,41 @@ sidebar_position: 0 --- -# Sidebar +# Sidebar Navigation -Navigation in the Admin Panel is done through the sidebar. It is possible to access different types of application resources, such as settings, dashboard and data tables. +The sidebar in the Admin Panel is your gateway to navigating the application. It provides access to a variety of resources, including settings, dashboard, and data tables. ![Sidebar](/img/admin_getting_started/admin-sidebar.png) -## User resources +## User Resources -In the side menu, the card containing user information provides access to settings and logout. +Within the sidebar, you'll find a user information card. This card offers quick access to settings and the logout option. ![User resources](/img/admin_getting_started/user-card.png) ### Settings -Settings have **account and system-related** functionality. +The Settings section encompasses both account and system-related functionalities. -Account-related resources: +Account-related options include: -- Change or add a photo -- Change email address -- Change name and password. +- Updating or adding a profile photo. +- Changing the email address. +- Modifying your name and password. -System-related resources: +System-related options include: -- Change the language -- Manage regions and other users\* +- Switching the application's language. +- Managing regions and other user accounts.* -\*_Feature available only for users with higher permission levels._ +\*_Note: User management features are only accessible to users with higher permission levels._ ![Settings](/img/admin_getting_started/admin-settings.png) -## Sidebar's divisions +## Divisions of the Sidebar -The admin panel is divided into 3 areas: +The Admin Panel is structured into three main areas: -- **Dashboard:** It is the main screen of the application, which displays information about the performance of the chosen region over a period determined by the user. -- **Questionnaire:** In this area you can access sections that contain information and resources related to the questionnaire used by Coaches during the Classroom Observation process. -- **Data:** This area has sections that contain tables with raw data that can be filtered, exported or viewed in more detail. +- **Dashboard:** The primary interface of the application, displaying performance data and analytics for a selected region over a user-defined time period. +- **Questionnaire:** This section offers access to information and tools related to the questionnaire used in the Classroom Observation process by Coaches. +- **Data:** Comprising sections that present raw data in tabular form, this area allows for filtering, exporting, and in-depth examination of data. diff --git a/docs/admin/sidebar-items/dashboard.md b/docs/admin/sidebar-items/dashboard.md index 67311b0..a89d7db 100644 --- a/docs/admin/sidebar-items/dashboard.md +++ b/docs/admin/sidebar-items/dashboard.md @@ -4,32 +4,32 @@ sidebar_position: 0 # Dashboard -The dashboard contains general data about a region over a specified period of time. +The Dashboard provides an overview of regional data over a specified time frame. ## Filters -The dashboard has filters that can be applied to select more specific information about regions, districts and municipalities, in addition, there is the possibility of determining the period for which you want to obtain the data. +To tailor the data, the Dashboard includes filters for selecting specific regions, districts, and municipalities. Additionally, users can define the time period for which they wish to retrieve data. ![Dashboard filters](/img/admin_getting_started/admin-dashboard-filters.png) -## Data sections +## Data Sections -It is possible to view data about: Engagement, Targeted improvement areas, Specific data for each Teaching Practice. +The Dashboard allows viewing data on Engagement, Targeted Improvement Areas, and Specific Data for each Teaching Practice. ### Engagement -The engagement data points out information about coaches and teachers activities for the chosen region in the given time. +This section offers insights into the activities of coaches and teachers in the selected region for the specified time period. ![Engagement section](/img/admin_getting_started/admin-dashboard-engagement.png) -### Targeted improvement areas +### Targeted Improvement Areas -The targeted improvement areas are the Teaching Practices chosen to be worked on with teachers. This information highlights which teaching practices teachers face the most difficulty in being better. +This area focuses on the Teaching Practices identified for enhancement with teachers. It highlights the practices where teachers most commonly struggle and need improvement. ![Targeted improvement areas](/img/admin_getting_started/admin-dashbord-targeted.png) -### Specific data for each Teaching Practice +### Specific Data for Each Teaching Practice -Below the targeted improment areas graph it is possible to select a Teaching Practice to view more about it. This section presents a more granular overview of how teachers are performing in the region in the time interval chosen for each Teaching Practice. +Located below the Targeted Improvement Areas graph, this feature allows users to select a Teaching Practice to examine in more detail. It provides a granular view of teacher performance in the chosen region and time interval for each specific Teaching Practice. ![Targeted improvement areas](/img/admin_getting_started/admin-dashboard-specific.png) diff --git a/docs/admin/sidebar-items/data.md b/docs/admin/sidebar-items/data.md index 8cde952..b1fc2f5 100644 --- a/docs/admin/sidebar-items/data.md +++ b/docs/admin/sidebar-items/data.md @@ -4,112 +4,95 @@ sidebar_position: 2 # Data -The data area contains more dense information about schools and sessions performed with the teacher. They are divided into the **Schools**, **Coaching activity** and **Sync log** pages. +The Data section provides detailed information about schools and coaching sessions with teachers. It is organized into **Schools**, **Coaching Activity**, and **Sync Log** sections. ## Schools -This page contains the main features for managing Schools. +This section is dedicated to managing school-related data. Features include: -In this page is possible to: - -- Add new schools -- Download the page's data -- Import data from a database -- Generate school's QR code -- Edit an existing school -- Delete a school +- Adding new schools. +- Downloading data from the current page. +- Importing data from a database. +- Generating a QR code for a school. +- Editing existing school details. +- Deleting a school. ![Teaching Practices page](/img/admin_getting_started/schools-page.png) -### Downloading page's data & Importing data - -The "import data" button allows you to select a CSV file from the computer. +### Downloading and Importing Data -The "Download data" button starts a download of a XLSX file to the computer. +- **Import Data**: Use the "Import Data" button to upload a CSV file from your computer. +- **Download Data**: Click the "Download Data" button to initiate the download of an XLSX file. -To use these functionalities, use the buttons at the top right of the screen. +These options are accessible via buttons located at the top right of the screen. ![Schools page's button](/img/admin_getting_started/schools-buttons.png) -### Add new school - -To add a new school, tap the "New school" button at the top right of the screen. +### Adding a New School -The button will open a drawer, where it is possible to add the name of the school, its EMIS number and region. +Click the "New School" button at the top right of the screen to add a new school. A form will appear where you can enter the school's name, EMIS number, and region. ![New Teaching Practice](/img/admin_getting_started/add-school.png) -### Actions in schools +### Managing Schools -The three-dot-button in each row of the table opens a menu of actions available of the school. +Each school entry has a three-dot-button that reveals available actions for that school. ![School's actions](/img/admin_getting_started/schools-actions.png) -The actions have the following functionalities: +#### Generate QR Code -#### Generate QR code - -Opens a screen that shows the QR code of the school. -The QR code is used by Coaches to setup their device with the school's data, this screen shoud be printed and displayed at schools so Coaches can setup the app. +Generates a QR code for the school, useful for Coaches to quickly set up their devices with the school's data. The QR code should be printed and made available for use at the school. ![QR code screen](/img/admin_getting_started/schools-qr-code.png) -#### Edit +#### Edit School Details -Opens a drawer that allows the user to change the school's name, EMIS and regions. +Allows editing of the school's name, EMIS number, and region. ![Editing a school](/img/admin_getting_started/schools-edit.png) -#### Delete +#### Delete School -Opens a modal confirming the action. Once deleted the school is removed from the list. +Initiates a confirmation modal. Once confirmed, the school is permanently removed. :::danger Irreversible action - -Be careful, this action is permanent and irreversible. - +This is a permanent and irreversible action. ::: ![Deleting a school](/img/admin_getting_started/schools-delete.png) +## Coaching Activity -## Coaching activity - -The coaching activity page presents a table of coaching sessions performed in each school. - -The table contains: +This page displays a table summarizing coaching sessions at each school, including: -- School name -- Number of coaches in the school -- Number of teachers that were coached -- Number of feedback sessions -- The distribution of coaching sessions in a range of: 0-30, 30-60, 60-90, 90+ days +- School name. +- Number of coaches. +- Number of teachers coached. +- Number of feedback sessions. +- Distribution of coaching sessions across time ranges: 0-30, 30-60, 60-90, 90+ days. ![Coaching sessions page](/img/admin_getting_started/coaching-activity-page.png) -## Sessions data +## Sessions Data -The sessions data page presents a table of feedback sessions performed in each school. +This page offers a detailed view of feedback sessions at each school, featuring: -The table contains: - -- School name -- Number of coaches in the school -- Number of teachers that were coached -- Number of feedback sessions -- The average rating of each Teaching Practice in the school +- School name. +- Number of coaches. +- Number of teachers coached. +- Number of feedback sessions. +- Average rating of each Teaching Practice at the school. ![Coaching sessions page](/img/admin_getting_started/sessions-data-page.png) -## Sync log - -The sync log page presents a table with information about the synchronization of the devices. +## Sync Log -The table contains: +The Sync Log page provides details about device synchronization, including: -- Android version -- Device model -- Device ID -- Date and time of the last update +- Android version. +- Device model. +- Device ID. +- Date and time of the last update. -![Coaching sessions page](/img/admin_getting_started/sync-log-page.png) \ No newline at end of file +![Coaching sessions page](/img/admin_getting_started/sync-log-page.png) diff --git a/docs/admin/sidebar-items/questionnary.md b/docs/admin/sidebar-items/questionnary.md index 25cde79..a277b96 100644 --- a/docs/admin/sidebar-items/questionnary.md +++ b/docs/admin/sidebar-items/questionnary.md @@ -2,111 +2,105 @@ sidebar_position: 1 --- -# Questionnary +# Questionnaire -The questionnary area contains features and information about Teaching Practices questions. They are divided into the **Teaching Practices** and **Coaching Sessions** pages. +The Questionnaire section offers tools and information related to Teaching Practices questions, divided into **Teaching Practices** and **Coaching Sessions** pages. ## Teaching Practices -This page contains the main features for managing Teaching Practices and questions that are answered by Coaches in the Class Observation process. +This page provides tools for managing Teaching Practices and their associated questions, used by Coaches during the Class Observation process. -In this page is possible to: +Features available on this page include: -- Add new teaching practices -- Download the page's data -- View questions in each teaching practice -- Edit an existing teaching practices -- Deactivate or active a teaching practice +- Adding new Teaching Practices. +- Downloading data from the page. +- Viewing questions under each Teaching Practice. +- Editing existing Teaching Practices. +- Activating or deactivating a Teaching Practice. ![Teaching Practices page](/img/admin_getting_started/teaching-practices-page.png) -### Downloading page's data +### Downloading Data -To download the page's data tap at the "Download data" button at the top right of the screen. +To download data from the page, click the "Download data" button at the top right of the screen. ![Teaching Practices page's button](/img/admin_getting_started/teaching-practices-buttons.png) -### Add new teaching practices +### Adding New Teaching Practices -To add a new teaching practice, tap the "Add new teaching practice" button at the top right of the screen. - -The button will open a drawer, where it is possible to add a name, a question and description to the question. +To add a new Teaching Practice, click the "Add new teaching practice" button at the top right. This opens a form to input the practice's name, a question, and a description. ![New Teaching Practice](/img/admin_getting_started/teaching-practices-new-tp.png) -Once the first question is saved ou can: +After saving the first question, you can: -- Edited the question created -- Delete the question created -- Add a new question +- Edit the created question. +- Delete the created question. +- Add additional questions. ![Adding questions](/img/admin_getting_started/teaching-practices-add-question.png) -Once all questions have been added, click the "Save" button to save the new teaching practice. +Click "Save" to finalize the new Teaching Practice. -### Actions in teaching practices +### Managing Teaching Practices -The three-dot-button in each row of the table opens a menu of actions available of the teaching practice. +The three-dot-button beside each Teaching Practice opens a menu with available actions. ![Teaching Practices' actions](/img/admin_getting_started/teaching-practices-actions.png) -The actions have the following functionalities: +Actions include: #### View -Opens a drawer that shows the questions in the given teaching practice. +Displays the questions associated with the selected Teaching Practice. ![Teaching Practices' actions](/img/admin_getting_started/teaching-practices-view.png) #### Edit -Opens a drawer that allows the user to change the teaching practice's name and their questions. +Allows editing of the Teaching Practice's name and questions. ![Teaching Practices' actions](/img/admin_getting_started/teaching-practices-edit.png) #### Activate/Deactivate -Once selected this feature will hide the teaching practice in the coaches app. +This feature toggles the visibility of the Teaching Practice in the coaches' app. ![Teaching Practices' actions](/img/admin_getting_started/teaching-practices-inactive.png) -:::warning Connection required - -The Coach needs to have access to the internet in the device to sync those modifications. - +:::warning Connection Required +Coaches must be online to sync these modifications. ::: ## Coaching Sessions -The coaching sessions page presents a table of each teaching practice performed. - -The table contains: +This page displays a table detailing each Teaching Practice session, including: -- School name -- Coach's name -- Teacher's name -- Subject of the class -- If a feedback was given afterwards +- School name. +- Coach's name. +- Teacher's name. +- Subject of the class. +- Whether feedback was given. ![Coaching sessions page](/img/admin_getting_started/coaching-sessions-page.png) -### Downloading page's data +### Downloading Data -To download the page's data tap at the "Download data" button at the top right of the screen. +To download the data, click the "Download data" button at the top right of the screen. ![Teaching Practices page's button](/img/admin_getting_started/coaching-sessions-button.png) -### View coaching session +### Viewing Coaching Sessions -The three-dot-button in each row of the table opens a menu of actions available of the coaching session. +Clicking the three-dot-button in each row opens a menu with options for that coaching session. ![Coaching sessions' actions](/img/admin_getting_started/coaching-sessions-actions.png) -Once you click to view the coaching session, a drawer will open with informations about the session, such as: +Selecting "View" opens a drawer with details of the session, such as: -- School's name -- Coach's name -- Teacher's name -- Assessment of teaching practice questions +- School's name. +- Coach's name. +- Teacher's name. +- Responses to Teaching Practice questions. ![Coaching session details](/img/admin_getting_started/coaching-sessions-details.png) diff --git a/docs/app/basic-usage/configuring-device.md b/docs/app/basic-usage/configuring-device.md index a72d579..3e2339b 100644 --- a/docs/app/basic-usage/configuring-device.md +++ b/docs/app/basic-usage/configuring-device.md @@ -2,44 +2,40 @@ sidebar_position: 1 --- -# Registering a school +# Registering a School -## Reading the first Qr Code - -:::caution Take care - -During the process of adding a new school, your device must not disconnect or turn off. Ensure that the battery is above 30%. +## Scanning the First QR Code +:::caution Important Reminder +During the process of adding a new school, ensure that your device does not disconnect or power off. It is recommended to have the battery charged above 30%. ::: -The first step to add a school to the application is to find its QRCODE. All QRCODEs are generated by the platform administration and are usually distributed as print materials in the school. After finding a QRCODE, it should look like the example below: - -![Sample of QRCODE](/img/registering_school/qrcode_sample.png) - -When accessing the application for the first time, you will see the button to scan a new QR CODE. Upon viewing, you should click it, and a permission request for the device camera must be accepted. After accepting, your camera will be opened. +The initial step in adding a school to the application involves scanning its QR code. QR codes are generated by the platform administration and are typically provided as printed materials at the school. A sample QR code is shown below: -![Sample of qrcode screen](/img/registering_school/scan_qrcode.png) +![Sample of QR CODE](/img/registering_school/qrcode_sample.png) -Once your camera is open, aim it at the school's QR CODE and fit it into the square marked on your tablet. Upon aiming, a loading screen will appear, and your device should start updating the application. +When you open the application for the first time, you'll find a button to scan a new QR code. Click this button, and you'll be prompted to grant camera access. Once permission is granted, your camera will activate. -## Adding more than one QR Code +![Sample of QR code screen](/img/registering_school/scan_qrcode.png) -:::tip Tip +Aim your camera at the school's QR code, fitting it within the on-screen square. The device will then display a loading screen and begin updating the application with the school's information. -This process can only be carried out after the account is created in the application. If you do not have an account yet, please refer to the topic 'Creating an Account'. +## Adding Additional QR Codes +:::tip Quick Tip +This procedure is only applicable after creating an account in the application. If you haven't set up an account yet, please refer to the 'Creating an Account' section. ::: -After registering the first QRCode, you still have the possibility to add any other schools you wish on the same device, keep in mind that each QRCODE represents a school. To register new schools, you need to scan the school's respective QR code to add them to your device. +Once the first QR code is registered, you can add more schools to the same device. Remember, each QR code represents a different school. To register additional schools, simply scan their respective QR codes. -To do this, follow the steps below: +Follow these steps to add more schools: -1. On the app's home screen, press the "Switch Schools" option. +1. On the app's home screen, select the "Switch Schools" option. -![HomeScreen Switch](/img/registering_school/home_switch.png) + ![Home Screen Switch](/img/registering_school/home_switch.png) -2. Next, you will see a screen where all your registered schools will be listed. On this screen, press Scan QrCode. +2. You'll be directed to a screen listing all registered schools. Here, select 'Scan QR Code'. -![Sample of switch screen](/img/registering_school/switch_schools.png) + ![Sample of switch screen](/img/registering_school/switch_schools.png) -3. After pressing, you will start the same synchronization flow as described above for a new QRCode. +3. Proceed with the synchronization process as you did with the first QR code. diff --git a/docs/app/basic-usage/creating-account.md b/docs/app/basic-usage/creating-account.md index 47f79d4..f75ae50 100644 --- a/docs/app/basic-usage/creating-account.md +++ b/docs/app/basic-usage/creating-account.md @@ -2,21 +2,20 @@ sidebar_position: 2 --- -# Creating a account +# Creating an Account -After registering a new school, you will need to create an account (Coach Profile) or select your already created one if you have it. -To do this follow the steps: +Once a new school has been registered, you'll need to either create a Coach Profile or select an existing one if you already have it. Follow these steps to proceed: -1. On the second screen, after the school selection, a list of Coach Profiles is displayed. If yours is not present, you can click on "Create New Profile". +1. **Selecting or Creating a Coach Profile**: + After choosing a school, a list of Coach Profiles will appear. If your profile isn't listed, select "Create New Profile". + ![Screenshot of Coach Profile list](/img/creating_account/select_coach_profile.png) -![Screenshot of Coach Profile list](/img/creating_account/select_coach_profile.png) +2. **Entering Profile Information**: + Clicking "Create New Profile" prompts you to enter various details. It's crucial that this information is provided accurately and truthfully. + + The screen for entering details will resemble the one below, with both optional and mandatory fields. After filling in all necessary information, click on "Create Account". + ![Screenshot of SignUp screen](/img/creating_account/signup_screenshot.png) -2. After clicking the button, some information will be requested, and it is extremely important that each of these questions be answered truthfully and accurately. +Congratulations! Once completed, you'll have full access to the app. -The screen where you will enter this information will be the same or extremely similar to the one below: - -![Screenshot of SignUp screen](/img/creating_account/signup_screenshot.png) - -On this screen, we have optional and non-optional fields. Once you fill in all the required information, simply click on "Create Account." Congratulations! Now you have full access to the app. - -The next topic refers to the screen you are currently viewing, the home screen. If you have any questions, don't hesitate to consult it. +The following topic covers the Home Screen, the current view you're on. If you encounter any issues or have questions, please refer to the relevant section for guidance. diff --git a/docs/app/basic-usage/discovering-home.md b/docs/app/basic-usage/discovering-home.md index 74b1250..c214c24 100644 --- a/docs/app/basic-usage/discovering-home.md +++ b/docs/app/basic-usage/discovering-home.md @@ -2,90 +2,84 @@ sidebar_position: 3 --- -# Discovering the home page +# Navigating the Home Screen -The first page you will see is the home screen, where you'll find most of the shortcuts to access the app's functionalities. Due to this screen containing several shortcuts, we will discuss a bit about each component. +Upon launching the app, the Home Screen is the first thing you'll encounter. This central hub contains shortcuts to various functionalities of the app. Let's delve into each component. -## Horizontal menu +## Horizontal Menu -In the first section of the home, where you see a horizontal menu, you'll find all the quick actions. These buttons quickly take you to specific screens within the application. +At the top of the Home Screen, the horizontal menu offers quick access to key features: ![Homescreen horizontal menu](/img/discovering_home/home_horizontal.png) -The quick actions include: +These quick actions include: -- **Start a new session:** Initiate a new Class Observation -- **Coach Script:** Coaches' manual -- **Pending Sessions:** List of all teachers with a class observation but no feedback -- **Statistics:** Visualization of statistics for available teachers -- **Switch Schools:** Option to choose another school -- **Switch Coach:** Option to choose another coach account -- **SignOut:** Log out of the application +- **Start a New Session:** Begins a new Class Observation. +- **Coach Script:** Access the manual for coaches. +- **Pending Sessions:** View a list of teachers awaiting feedback post-observation. +- **Statistics:** Explore statistics related to available teachers. +- **Switch Schools:** Change between schools. +- **Switch Coach:** Switch between different coach accounts. +- **Sign Out:** Log out from the application. -Over time, these functionalities may change, but the logic of this menu always leading quickly to a functionality will remain the same. +The functionalities of this menu may evolve, but its purpose of providing rapid access to key features remains constant. -## Teachers +## Teachers Section -After the horizontal menu session, we have the complete list of teachers, with some key information about them, such as: +Below the horizontal menu is a comprehensive list of teachers, showcasing: -- Number of class observations -- Date of a class observation +- The number of class observations per teacher. +- The date of the last class observation. ![Homescreen teacher list](/img/discovering_home/teachers_list.png) -If you click on one of these teachers, you will navigate to the detailed view about the teacher, and on this screen, you can create your Class Observation! +Selecting a teacher navigates to a detailed view, where you can initiate Class Observation. -### Adding new teachers +### Adding New Teachers -It is possible for coaches to create teachers that still doesn't exist in the system. -To add a new teacher, follow the steps: +Coaches can add teachers not yet registered in the system: -1. At the home of the app, in the teachers section, click on the top right button labeled "Add new teacher". +1. On the Home Screen, in the teachers section, tap "Add New Teacher". -2. After clicking the button you will be redirected to a form to fill informations about the teacher. It is extremely important that each of these questions be answered truthfully and accurately once they will serve to diferentiate the teachers. +2. You'll be directed to a form to input the teacher's details. Accuracy and truthfulness are crucial as this information is used to distinguish between teachers. -The form contains fields about: + The form includes fields for: -- **Name and surname:** The name and surname will be the principal way to identify the teacher, make sure you get them correctly. -- **Taking pictures:** You can add a photo to the teacher profile by tapping on 'Take/choose photo'. Adding a photo makes it easier to recognize a teacher in the menu. Ask the teacher to let you take their photo. -- **EMIS number:** The EMIS number (Education Management Information System) helps identify the teacher. Ask the teacher for this information when you are creating their profile. -- **Date of birth:** Ask the teacher for their date of birth; this information helps identify the teacher if the EMIS number is unknown. + - **Name and Surname:** Primary identifiers of the teacher. + - **Taking Pictures:** Optionally add a photo for easier identification. + - **EMIS Number:** A unique identifier in the Education Management Information System. + - **Date of Birth:** Additional identification detail. + ![Adding new teacher form](/img/discovering_home/new_teacher_form.png) -![Adding new teacher form](/img/discovering_home/new_teacher_form.png) + :::tip + If some details are unavailable, you can fill in the essential information and update the profile later. + ::: -:::tip Tip +3. Once completed, the new teacher will be available in the Home Screen’s teacher list. -In case you don't know or don't have access to all information in the form, you can fill the required information and later edit the teacher profile in the Editing teacher flow. +### Editing a Teacher's Profile -::: +To update a teacher's details: -3. Once all the required information is fulfilled the teacher can be selected in the teacher's list at the home of the app. +1. From the Home Screen, select the teacher. +2. In their profile, tap "Edit Teacher". -### Editing a teacher + ![Edit teacher button](/img/discovering_home/edit_teacher_button.png) -In case you need to edit or add new information to the teacher profile, you can follow the steps: +3. Update or fill in the teacher's information. -1. At the home of the app, select the teacher you want to edit the profile. + ![Edit teacher form](/img/discovering_home/edit_teacher_form.png) -2. At the teacher profile, click on the "Edit teacher" button. +4. Finalize by clicking "Edit Teacher". -![Edit teacher button](/img/discovering_home/edit_teacher_button.png) +## Quick Actions -3. Fill empty fields or edit filled fields with information about the teacher. +The bottom part of the Home Screen provides shortcuts to specific app views like: -![Edit teacher form](/img/discovering_home/edit_teacher_form.png) +- Teaching Learning Circles. +- Pending Sessions. -4. Once you are finished, conclude the process clicking on the "Edit teacher" button. +![Homescreen quick actions](/img/discovering_home/quick_actions.png) - -## Quick actions - -Finally, the bottom part of the home screen offers the possibility to navigate to other app views that are more specific to your daily life, including: - -- Teaching Learning Circles -- Pending Sessions - -![Homescreen teacher list](/img/discovering_home/quick_actions.png) - -All these features aim to make it easier for you to use the app by providing views that can be found in other parts of the application with just a few clicks. Don't forget to try each of them and don't be afraid to click! This will bring you greater ease and discovery within the application. +These features are designed for convenience, offering alternative routes to various app functionalities. Explore each feature for a more streamlined experience. diff --git a/docs/app/class-observation/about-lesson.md b/docs/app/class-observation/about-lesson.md index a80e4de..2278958 100644 --- a/docs/app/class-observation/about-lesson.md +++ b/docs/app/class-observation/about-lesson.md @@ -2,16 +2,14 @@ sidebar_position: 1 --- -# About the lesson +# About the Lesson -On the "About the lesson" screen, you will encounter the initial questions for class observation. These questions constitute some of the few open-ended inquiries in the Class Observation. They need to be answered calmly and attentively. Most fields are selectable, except for the Objectives field in the last question. +The "About the Lesson" screen is where you'll start the Class Observation process. This section includes initial questions that are mostly open-ended and require thoughtful and attentive responses. While most fields are selectable, the Objectives field in the last question is an exception. ![Screenshot of About the lesson](/img/about_lesson/about_lesson.png) -:::tip Tip - -Spare some time with the teacher to complete the form about the lesson. - +:::tip Helpful Advice +Allocate ample time to collaboratively fill out this form with the teacher. ::: -After completing the form, click on Next, wait for a moment, and you will be directed to the evaluation screen. It's common during this loading process to experience a brief wait as everything appears on the screen. Depending on the device, this process may take up to 2 seconds. +Once the form is completed, press "Next". You may experience a brief loading period as the evaluation screen prepares to display. This wait time, usually no more than 2 seconds, varies depending on the device's performance. diff --git a/docs/app/class-observation/how-to-start.md b/docs/app/class-observation/how-to-start.md index 3a74776..ea1c473 100644 --- a/docs/app/class-observation/how-to-start.md +++ b/docs/app/class-observation/how-to-start.md @@ -2,38 +2,38 @@ sidebar_position: 0 --- -# Starting a new class observation +# Starting a New Class Observation -After a teacher is created, there are 2 ways to start a class observation with them: through the Horizontal Menu or by selecting the teacher in the teachers list. +Once a teacher is registered, there are two methods to initiate a class observation: via the Horizontal Menu or by selecting the teacher from the teachers list. -## In the horizontal menu +## Using the Horizontal Menu -1. At the home of the app, click on the "Start new session" card +1. On the Home Screen, tap the "Start New Session" card. -![Horizontal menu](/img/home/home_header.png) + ![Horizontal menu](/img/home/home_header.png) -2. Select a teacher to start a class observation with. +2. Choose a teacher to begin the class observation. -![Select a teacher to start a new session](/img/start_observation/select_teacher_new_session.png) + ![Select a teacher to start a new session](/img/start_observation/select_teacher_new_session.png) -## Selecting a teacher at home +## Selecting a Teacher from the Home Screen -1. At the home of the app, search in the teachers list which teacher you would like to start a class observation with. +1. Navigate to the teachers list on the Home Screen and select the teacher with whom you want to start a class observation. -2. At the teacher profile, click on the "New class observation" button +2. In the teacher's profile, click the "New Class Observation" button. -![Teacher profile](/img/start_observation/teacher_profile.png) + ![Teacher profile](/img/start_observation/teacher_profile.png) -# Coaching process overview +# Overview of the Coaching Process -After selecting a teacher and starting the class observation, the a timeline of the Coaching Process will be displayed to provide an overview of the steps you are going to go through. +Upon selecting a teacher and commencing the class observation, a timeline of the Coaching Process will appear, outlining the steps you'll be following. -![Teacher profile](/img/start_observation/coaching_process_overview.png) +![Coaching process overview](/img/start_observation/coaching_process_overview.png) # Preparation -Before starting the observation of the class a preparation is essencial, to help you get ready the app will present 3 tips of good practices for the class observation. +Proper preparation is essential before observing a class. To assist you, the app provides three tips for best practices during class observation. -![Teacher profile](/img/start_observation/preparation_tip.png) +![Preparation tips](/img/start_observation/preparation_tip.png) -Now you have started the Class Observation, the next topic refers to a practical step, the preparation form. +With the Class Observation now underway, the next topic will guide you through the practical steps, starting with the preparation form. diff --git a/docs/app/class-observation/rating-competences.md b/docs/app/class-observation/rating-competences.md index 90a8974..1aa572c 100644 --- a/docs/app/class-observation/rating-competences.md +++ b/docs/app/class-observation/rating-competences.md @@ -2,15 +2,16 @@ sidebar_position: 2 --- -# Rating competences +# Rating Competencies -The principal aspect of the class observation is the rating process. On this screen, you can rate the class you are observing based on the Teaching Practices. +A key element of class observation is the rating process. This section allows you to evaluate the class based on various Teaching Practices. -## How to rate +## How to Rate -Click on a star to rate a Micro Teaching Practice. +To rate a Micro Teaching Practice, simply click on a star. + +The number of stars selected reflects the rating level. Fewer stars indicate a lower score. There are two rating scales used in the app: 3-star and 5-star. -The number of stars corresponds to the value of the rating. Therefore, the lower the number of stars, the lower the score. There are two types of ratings in the app: 3-star and 5-star. For 3-star ratings: - 1 star = Low rating - 2 stars = Medium rating @@ -24,28 +25,28 @@ For 5-star ratings: ![Rating class observation](/img/class_observation/rating_class_observation.png) -## Confirming the class observation +## Confirming the Class Observation -To complete the class observation, review the summary of the rating and confirm it. +After rating, review the summary of your evaluations and confirm to complete the observation. ![Class observation Summary](/img/class_observation/class_observation_summary.png) -# Finishing the class observation +# Completing the Class Observation -Once the class observation is complete, there are 2 options to follow up: start a Coaching Session with the teacher or return to the home of the app. +Upon completing the class observation, two follow-up options are available: begin a Coaching Session with the teacher or return to the home screen of the app. ![Class observation complete](/img/class_observation/class_observation_complete.png) -## Start Coaching Session +## Starting a Coaching Session -If starting a Coaching Session was chosen, the feedback session will be started. +Choosing to start a Coaching Session will initiate the feedback process for the teacher. -View more about in the Coaching Session topic. +More details on this can be found in the Coaching Session section. -## Return to the home +## Returning to the Home Screen -Returning to the home of the app will result in a Incomplete Session, which means an Observation Session was completed but the teacher still didn't receive a feedback about it. +Returning to the home screen without providing feedback will result in an Incomplete Session. This indicates that while an Observation Session has been conducted, feedback has yet to be given. -Teachers with incomplete sessions will be displayed with an alert sign at the home of the app. +Teachers with incomplete sessions will be marked with an alert symbol on the home screen. ![Home with an incomplete session](/img/incomplete_session/home_incomplete_session.png) diff --git a/docs/app/coaching-process/how-to-start.md b/docs/app/coaching-process/how-to-start.md index fe9509f..c6d5cab 100644 --- a/docs/app/coaching-process/how-to-start.md +++ b/docs/app/coaching-process/how-to-start.md @@ -2,34 +2,34 @@ sidebar_position: 0 --- -# Starting Coaching sessions +# Initiating Coaching Sessions -Once the class observation is over, the coach and the teacher must conduct a coaching session. +Following the completion of a class observation, it's essential for the coach and the teacher to engage in a coaching session. -There are two ways to start a Coaching Session: right after finishing a class observation or by selecting a teacher with a incomplete session. +There are two scenarios for starting a Coaching Session: immediately after a class observation or by selecting a teacher with an incomplete session. -## After a class observation +## After Completing a Class Observation -After the class observation is performed, you can choose between starting a Coaching Session or returning to the home of the app +Once the class observation concludes, you have the option to either start a Coaching Session or return to the app's home screen. ![Class observation complete](/img/class_observation/class_observation_complete.png) -:::caution This will result in a incomplete session - -Choosing return to the home of the app will result in a Incomplete Session and you will need to perform a Coaching Session with the teacher as soon as possible. - +:::caution Incomplete Session Alert +Opting to return to the home screen without initiating a Coaching Session results in an Incomplete Session. It's important to schedule a Coaching Session with the teacher at the earliest convenience. ::: -## Incomplete session +## Managing Incomplete Sessions -Teachers with incomplete sessions will be displayed with an alert sign at the home of the app. +Teachers with incomplete sessions are indicated by an alert sign on the home screen. ![Home with an incomplete session](/img/incomplete_session/home_incomplete_session.png) -To perform a feedback for teachers with an incomplete session, select the teacher and resume the session. +To provide feedback for teachers with incomplete sessions: + +1. Select the teacher from the home screen to resume the session. -![Teacher with incomplete session](/img/incomplete_session/teacher_profile_incomplete_session.png) + ![Teacher with incomplete session](/img/incomplete_session/teacher_profile_incomplete_session.png) -Once the session is resumed, review the observation rating and start the feedback. +2. Review the class observation ratings and proceed to start the feedback process. -![Review class observation rating](/img/incomplete_session/review_class_observation_summary.png) \ No newline at end of file + ![Review class observation rating](/img/incomplete_session/review_class_observation_summary.png) diff --git a/docs/app/coaching-process/performing-a-feedback.md b/docs/app/coaching-process/performing-a-feedback.md index ff23135..515ec40 100644 --- a/docs/app/coaching-process/performing-a-feedback.md +++ b/docs/app/coaching-process/performing-a-feedback.md @@ -2,26 +2,22 @@ sidebar_position: 1 --- -# Performing a feedback +# Conducting Feedback -Once the Coaching Session has been started, the coach must select the micro-teaching practice for the teacher to work on and register the feedback. +During the Coaching Session, the coach is responsible for selecting a specific micro-teaching practice for the teacher to focus on and documenting the feedback. -## Selecting a teaching practice to work +## Choosing a Micro-Teaching Practice -The first part of the coaching session is to define a micro teaching practice to work with the teacher. -Only **one** micro-teaching practice can be selected per coaching session. +The initial phase of the coaching session involves selecting a micro-teaching practice for improvement. Note that only **one** micro-teaching practice can be chosen per session. -![Class observation complete](/img/coaching_process/select_micro_teaching_practice.png) - -:::tip Tip - -It is recommended to select a Teaching Practices that was not worked before and with the lower rating. +![Selecting micro-teaching practice](/img/coaching_process/select_micro_teaching_practice.png) +:::tip Recommendation +It's advisable to choose a Teaching Practice that hasn't been previously focused on and has received a lower rating. ::: -## Registering the feedback +## Documenting the Feedback -The final step of the coaching session is to register what was discussed with the teacher and the defined actions for improvement. -The feedback can be input as a photo of the notes taken or by typing in the text input field. +The culmination of the coaching session is the recording of the discussion and agreed-upon actions for improvement with the teacher. Feedback can be entered either as a photo of handwritten notes or by typing directly into the text input field. -![Class observation complete](/img/coaching_process/feedback_content.png) \ No newline at end of file +![Feedback documentation](/img/coaching_process/feedback_content.png) diff --git a/docs/app/community-of-practice.md b/docs/app/community-of-practice.md index c090c4c..992ffb6 100644 --- a/docs/app/community-of-practice.md +++ b/docs/app/community-of-practice.md @@ -4,62 +4,62 @@ sidebar_position: 6 # Community of Practice (CoP) -The CoP is the third step of Coach. It is conducted by the Head Teacher and can be supported by Lead Teachers. +The Community of Practice (CoP) is the third phase in the Coaching process, typically led by the Head Teacher and supported by Lead Teachers. -At this stage, all teachers come together to reflect on the positive and negative points they had during the Coaching process and define strategies together to improve. +This stage brings all teachers together to reflect on their experiences during the Coaching process, discussing both successes and challenges, and collaboratively developing strategies for improvement. -### Starting a Community of Practice +### Initiating a Community of Practice -To start a Community of Practice, go to the **home of the app** and, in the tab bar at the bottom of the screen, select the Community of Practice item. +To start a CoP session: -![Class observation complete](/img/community_of_practice/home.png) +1. **Navigate to CoP Section**: From the home screen of the app, select the 'Community of Practice' option in the bottom tab bar. -### Reviewing the steps + ![Accessing CoP from home screen](/img/community_of_practice/home.png) -Before starting a Community of Practice, the app will present the steps of the activity. +### Reviewing CoP Steps -![Class observation complete](/img/community_of_practice/start.png) +Before beginning, the app outlines the steps involved in conducting a CoP session. -### Checking stats +![CoP start overview](/img/community_of_practice/start.png) -In this step, the app will show to the teacher conducting the activity the school's stats. This way, the head teacher will know what the main focuses of the Community of Practice should be. +### Examining School Stats -![Class observation complete](/img/community_of_practice/check-stats.png) +This phase presents the school's statistics to the facilitator, helping the Head Teacher identify key focus areas for the CoP session. +![Checking school statistics](/img/community_of_practice/check-stats.png) -### Reflection exercise +### Reflection Exercise -The participants must reflect, share and take note of insights about good practices of teaching. The notes must be inputed in the app. +Participants are encouraged to reflect, share, and record insights about effective teaching practices. -![Class observation complete](/img/community_of_practice/insights.png) +- **Documenting Insights**: Notes should be entered directly into the app. -#### Uploading a photo + ![Recording insights](/img/community_of_practice/insights.png) -It is possible to upload a photo instead of typing. To upload a file, tap at the "Upload a photo" button and select if you want to take a picture with the camera or select a photo at the gallery. +- **Uploading Photos**: Optionally, photos can be uploaded by tapping "Upload a photo" and choosing from the camera or gallery. -![Class observation complete](/img/community_of_practice/insights-1.png) + ![Uploading insights photo](/img/community_of_practice/insights-1.png) -### Sharing positives +### Sharing Positive Strategies -The participants can share and highlight some good strategies they have being using at the classroom. The notes must be inputed in the app. +Teachers share and document positive strategies they've implemented in their classrooms. -![Class observation complete](/img/community_of_practice/positives.png) +![Sharing positive strategies](/img/community_of_practice/positives.png) -### Improvements +### Discussing Improvements -The participants must reflect, share and take note of insights about what needs improvement. The notes must be inputed in the app. +This step involves reflecting and noting areas requiring improvement. -![Class observation complete](/img/community_of_practice/improvements.png) +![Noting areas for improvement](/img/community_of_practice/improvements.png) -### Next steps +### Defining Next Steps -At the final part, the participants must discuss and define some actions to achieve improvement in what was poited out at the previous step. The notes must be inputed in the app. +In the final part, participants discuss and agree on actions for improvement, based on the previous discussions. -![Class observation complete](/img/community_of_practice/improvements.png) +![Defining next steps](/img/community_of_practice/improvements.png) -### CoP complete +### Completing the CoP Session -Once participants complete all steps, the Community of Practice will come to an end and teachers will have to apply the action plan in their day-to-day practice. - -![Class observation complete](/img/community_of_practice/finish.png) +Upon completing all steps, the CoP session concludes. Teachers are then expected to apply the formulated action plan in their daily teaching practices. +![CoP completion](/img/community_of_practice/finish.png) diff --git a/docs/app/installation.md b/docs/app/installation.md index 7e4f877..071937d 100644 --- a/docs/app/installation.md +++ b/docs/app/installation.md @@ -2,68 +2,66 @@ sidebar_position: 0 --- -# Install - -:::tip A little tip - -Try to reproduce this documentation in real time as you read it; this will make it easier to apply the content. +# Installation Guide +:::tip Suggestion +To enhance your understanding, try following these installation steps in real-time as you read through this guide. ::: -## Minimum Requirements +## Checking Minimum Requirements -Before installing the app, the first step is to ensure that your device meets the minimum requirements to run the application. These minimum requirements are: +Before installing the app, verify that your device meets the following minimum requirements: -- Android version higher than 4 -- At least 512 MB of RAM +- Android version 4 or higher. +- At least 512 MB of RAM. -Different manufacturers may display this information in their own way in various places on the device, but in most cases, you can check these details by navigating to: -`Settings > About the device` (usually the last option) +You can usually find this information by navigating to: +`Settings > About the device` (often the last option). -## How to Download +## Downloading the App -To download the app, the first step is to ensure you have a minimally stable internet connection, which can be either 3G or 4G. Once you have this connection, follow the steps below: +Ensure you have a stable internet connection (3G or 4G) before starting the download process: -1. Go to the application's download website located at: [download.coachdigital.org](http://download.coachdigital.org) +1. Visit the application's download page: [download.coachdigital.org](http://download.coachdigital.org) -![Docusaurus logo](/img/install/url.png) + ![Download page](/img/install/url.png) 2. Click on the download button. -![Docusaurus logo](/img/install/download.png) + ![Download button](/img/install/download.png) -3. Allow the download into the box. +3. Grant permission for the download if prompted. -![Docusaurus logo](/img/install/permission.png) + ![Download permission](/img/install/permission.png) -Now, all you have to do is monitor the progress and wait for the download to finish before moving on to the next step. +Monitor the progress until the download is complete. -## Installation Guide for Android Application +## Android Installation Guide -This guide provides step-by-step instructions on how to install the CoachApp on an Android device. +This section provides a detailed guide for installing CoachApp on an Android device. -### Unknown Sources APK Installation: +### Installing an APK from Unknown Sources: -- Tap on the downloaded APK file. -- If you see any error about unknown sources, see the topic: [Enabling Unknow Sources](./installation#tip-enable-installation-from-unknown-sources) -- Read and accept the permissions requested by the application. -- Tap the "Install" button. -- Once installed, tap the "Open" button to launch the application. +- Open the downloaded APK file. +- If prompted about unknown sources, refer to the section: [Enabling Installation from Unknown Sources](./installation#tip-enable-installation-from-unknown-sources). +- Review and accept the permissions requested by the app. +- Tap "Install." +- Once installed, select "Open" to start the app. -### Tip: Enable Installation from Unknown Sources +### Enabling Installation from Unknown Sources -You need to enable installations from unknown sources. Follow these steps: +For APK installation, you may need to enable installations from unknown sources: -1. Open the device "Settings." -2. Navigate to "Security" or "Privacy" settings. +1. Open "Settings" on your device. +2. Go to "Security" or "Privacy" settings. 3. Enable the "Unknown sources" option. -_Note: Be cautious when enabling this option, and only install applications from trusted sources._ +_Caution: Always be careful when enabling this option and download apps only from trusted sources._ -## Application Setup +## Finalizing Setup - +After installation, follow the on-screen instructions for initial setup, including account creation or login. -**Congratulations!** You have successfully installed CoachApp on your Android device. +**Congratulations!** You've successfully installed CoachApp on your Android device. -_Note: Ensure that you keep the application updated to access the latest features and security improvements._ +_Remember to regularly update the app to access the latest features and security enhancements._ diff --git a/docs/app/teachers-data/about-teachers-data.md b/docs/app/teachers-data/about-teachers-data.md index 3ff2296..eaa61bb 100644 --- a/docs/app/teachers-data/about-teachers-data.md +++ b/docs/app/teachers-data/about-teachers-data.md @@ -2,18 +2,16 @@ sidebar_position: 0 --- -# Teacher's data +# Analyzing Teacher Data -As classroom observations and feedback are carried out in the application, the corresponding teacher's profile will accumulate data. Use this data to provide richer feedback and better guide teachers in their development. +As classroom observations and feedback sessions accumulate in the application, a comprehensive data profile is built for each teacher. This data is instrumental in providing insightful feedback and effectively guiding teachers in their professional development. -The teacher profile presents two types of data: previous sessions and teacher statistics. +A teacher's profile in the app displays two main types of data: Previous Sessions and Teacher Statistics. -## Previous sessions +## Reviewing Previous Sessions -Once a teacher who already has other completed sessions has been selected, it is possible to view the class rating and feedback from old sessions, therefore, it is possible to see pictures uploaded and actions to improve submitted. +When selecting a teacher with prior completed sessions, you can access historical data. This includes class ratings, feedback from past sessions, uploaded pictures, and proposed improvement actions. -## Teacher statistics +## Understanding Teacher Statistics -After conducting the **minimum number of 3 coaching sessions** with a teacher, the statistics are unlocked. - -With statistics you can visualize the historical evolution of the teacher for each Teaching Practice. This way, it is possible to check whether the teacher has improved or worsened in relation to previous sessions conducted. \ No newline at end of file +Teacher statistics become available after completing a **minimum of three coaching sessions** with a teacher. These statistics offer a historical view of the teacher's performance in each Teaching Practice. This feature allows you to track the teacher's progress over time, identifying areas of improvement or decline in comparison to previous sessions. diff --git a/docs/app/teachers-data/previous-sessions.md b/docs/app/teachers-data/previous-sessions.md index c55bf80..3bf1502 100644 --- a/docs/app/teachers-data/previous-sessions.md +++ b/docs/app/teachers-data/previous-sessions.md @@ -2,32 +2,34 @@ sidebar_position: 1 --- -# Previous sessions +# Accessing Previous Sessions -To view a previous session, follow the steps: +To examine details from a previous session, here are the steps to follow: -1. Select a teacher at the home of the app and click to view their profile. +1. **Select a Teacher**: + Go to the home screen of the app and click on a teacher's profile to view it. -In the teacher profile, the sessions will be ordered from most recent to oldest and present some relevante information such as: + Within the profile, sessions are listed chronologically from the most recent to the oldest. Each session includes relevant information such as: -- Session number -- Creation date -- How the teacher is performing bases on their average rating of the teaching practices + - Session number. + - Creation date. + - Teacher's average rating across Teaching Practices. -![Teacher profile with previous sessions](/img/teachers_data/teacher_profile_with_sessions.png) + ![Teacher profile with previous sessions](/img/teachers_data/teacher_profile_with_sessions.png) -2. Select a session to view details. +2. **Choose a Specific Session**: + Click on a session to view more details about it. -![Previous session selected](/img/teachers_data/previous_session.png) + ![Previous session selected](/img/teachers_data/previous_session.png) -3. Select which details you want to see +3. **Review Session Details**: -Once a session has been selected, it is possible to view both the class evaluation and the feedback provided. + After selecting a session, you can access detailed evaluations and feedback: -- **Classroom evaluation:** If you choose to view the class evaluation, you will be presented with the summary of the ratings you made during the Class Observation process. + - **Classroom Evaluation**: Viewing the class evaluation presents a summary of the ratings assigned during the Class Observation process. -![Previous classroom observation](/img/teachers_data/previous_observation.png) + ![Previous classroom observation](/img/teachers_data/previous_observation.png) -- **Feedback provided:** If you choose to view feedback, you will be presented with the text input and/or photo submitted during the Coaching Session. + - **Feedback Provided**: Opting to view feedback shows the text or photo feedback submitted in the Coaching Session. -![Previous feedback provided](/img/teachers_data/previous_feedback.png) \ No newline at end of file + ![Previous feedback provided](/img/teachers_data/previous_feedback.png) diff --git a/docs/app/teachers-data/statistics.md b/docs/app/teachers-data/statistics.md index 7de653d..3c009d3 100644 --- a/docs/app/teachers-data/statistics.md +++ b/docs/app/teachers-data/statistics.md @@ -2,50 +2,53 @@ sidebar_position: 2 --- -# Statistics +# Teacher Statistics -After conducting the minimum number of 3 coaching sessions with a teacher, the statistics is unlocked. +Statistics become available after completing at least three coaching sessions with a teacher. -To view a teacher's statistics, follow the steps: +To view a teacher's statistics: -1. Select a teacher at the home of the app and click to view their profile. +1. **Access Teacher Profile**: + From the home screen, select a teacher and view their profile. -2. At the teacher profile, change the tab to Teacher's stats +2. **Navigate to Teacher Stats**: + Switch to the 'Teacher's Stats' tab within the teacher's profile. -![Teacher profile with previous sessions](/img/teachers_data/teacher_profile_tabs.png) + ![Teacher profile with statistics tab](/img/teachers_data/teacher_profile_tabs.png) -3. In the teacher's stats it is possible to view: +3. **Review Statistical Data**: + In the stats section, you can examine: -- Teacher's overall rating -- Teacher's evolution in the Teaching Practices -- Detailed data in each Teaching Practices + - The teacher's overall rating. + - The teacher's progress in each Teaching Practice. + - Detailed data for individual Teaching Practices. -![Teacher profile with previous sessions](/img/teachers_data/teacher_profile_stats.png) + ![Teacher statistics overview](/img/teachers_data/teacher_profile_stats.png) -## Teacher overall rating +## Teacher Overall Rating -The overall rating represents the teacher's average of all Teaching Practices in the last observation performed. This information shows the current status of the teacher. +The overall rating reflects the teacher's average across all Teaching Practices in the most recent observation. This metric indicates the teacher's current performance level. -![Teacher profile with previous sessions](/img/teachers_data/overall_rating.png) +![Teacher overall rating](/img/teachers_data/overall_rating.png) -## Teacher evolution +## Teacher Evolution -Ainda no perfil do professor, é possível visualizar a evolução simplificada do professor em cada Teaching Practice. Esta seção informa se houve melhoria ou piora na Teaching Practice desde a última sessão. +In the teacher's profile, a simplified evolution of performance in each Teaching Practice is also displayed. This section provides insights into improvements or declines since the last session. -![Teacher profile with previous sessions](/img/teachers_data/teacher_evolution.png) +![Teacher evolution in practices](/img/teachers_data/teacher_evolution.png) -## Detailed data in each Teaching Practices +## Detailed Data for Each Teaching Practice -When you click on the "See details" button in a teaching practice, the statistics detail screen for that Teaching Practice will be displayed. In this screen you can: +By clicking "See details" on a specific Teaching Practice, a detailed statistical page opens. Here, you can: -- Navigate between teaching practices -- View evolution graph for the corresponding Teaching Practice -- View rating in each session for the corresponding Teaching Practice +- Switch between different Teaching Practices. +- View an evolution graph for each Teaching Practice. +- See ratings from each session for the selected Teaching Practice. -![Teacher profile with previous sessions](/img/teachers_data/teacher_stats_detailed.png) +![Detailed Teaching Practice statistics](/img/teachers_data/teacher_stats_detailed.png) -### How to change between Teaching Practices +### Navigating Between Teaching Practices -Navigate between Teaching Practices using the arrows next to the Teaching Practice name. +To switch between Teaching Practices, use the arrows adjacent to the name of the Teaching Practice. -![Teacher profile with previous sessions](/img/teachers_data/teacher_stats_detailed_navigation.png) +![Navigating between Teaching Practices](/img/teachers_data/teacher_stats_detailed_navigation.png) diff --git a/docs/app/terminologies.md b/docs/app/terminologies.md index 1ccd831..689cc5e 100644 --- a/docs/app/terminologies.md +++ b/docs/app/terminologies.md @@ -2,47 +2,48 @@ sidebar_position: 1 --- -# Terminologies +# Key Terminologies in Coaching -## Class observation +Understanding specific terms used in the coaching process can enhance clarity and effectiveness. Below are explanations of key terminologies: -Class observation is the first part of the coaching process. It occurs when the coach schedules a session with the selected teacher to observe their class and rate each teaching practice in the Coach's app. Once the observation is complete, the teacher and the coach sit together to conduct a feedback session. +## Class Observation -View more about this at the [Class Observation page](class-observation/how-to-start) +Class observation is the initial phase of the coaching process. It involves the coach scheduling and conducting a session to observe a teacher's class, assessing each teaching practice using the Coach's app. Post-observation, the coach and the teacher engage in a feedback session. -## Coaching session +For more details, visit the [Class Observation page](class-observation/how-to-start). -The coaching session is the second and final part of the coaching process, occurring after a class observation. The coach selects a teaching practice that needs improvement based on the observation of the class. Both the teacher and the coach must discuss what needs to be worked on and define actions for improvement together. +## Coaching Session -View more about this at the [Coaching Process page](coaching-process/how-to-start) +A coaching session is the concluding phase of the coaching process, following a class observation. The coach identifies a teaching practice needing improvement and collaborates with the teacher to discuss necessary enhancements and action plans. + +Learn more at the [Coaching Process page](coaching-process/how-to-start). ## Teacher Learning Circle -Teacher Learning Circles are sessions led by Head Teachers that occur once a month. During these sessions, teachers sit in a group and focus on learning together about one key teaching practice. +Teacher Learning Circles, facilitated by Head Teachers, are monthly collaborative learning sessions where teachers collectively focus on a specific teaching practice. -## Coach profile +## Coach Profile -The coach profile contains the coach's personal information such as name, birthday and identification numbers. All data collected by the coach in the school is linked to the coach profile (e.g. teachers added, class observations, coaching sessions). +A coach profile includes personal details like name, birthdate, and identification numbers. It links all data collected by the coach at the school, including added teachers, class observations, and coaching sessions. -View more about this at the [Basic usage page](basic-usage/creating-account) +For more information, see the [Basic Usage page](basic-usage/creating-account). -## Teacher profile +## Teacher Profile -The teacher profile contains the teacher's personal information such as name, birthday and identification numbers. All data generated by performing class observations and coaching sessions with the corresponding teacher is linked to their profile. The teacher profile also provides statistics about the teacher based in the data. +A teacher profile contains personal information of the teacher and links all data from class observations and coaching sessions. It also provides statistics based on this data. -View more about the teacher profile at the [Teacher section in the basic usage page](basic-usage/discovering-home) and the statistics at the [Teacher data page](teachers-data/about-teachers-data) +For more on teacher profiles, visit the [Teacher section in the Basic Usage page](basic-usage/discovering-home) and [Teacher Data page](teachers-data/about-teachers-data). -## Incomplete sessions +## Incomplete Sessions -A session is considered incomplete if the coach completes a class observation but doesn't conduct a coaching session. -To complete a session, the coach must schedule some time with the teacher, select their profile and conduct a coaching session, providing clear feedback about the last class observation. +A session is deemed incomplete if a class observation is done without the follow-up coaching session. To complete it, the coach should schedule time with the teacher to conduct a coaching session and provide feedback on the observed class. -View more about this at the [Coaching Process page](coaching-process/how-to-start) +Further details can be found on the [Coaching Process page](coaching-process/how-to-start). ## Teaching Practices -Teaching Practices are the skills that the teacher must meet to demonstrate progress in a given subject. In the coach's app, the teaching practice is represented by each group of questions to be answered by the Coach during a Class Observation. +Teaching Practices are key skills that a teacher needs to demonstrate proficiency in a subject. In the Coach's app, these are represented by question groups to be evaluated during Class Observation. -## Micro-teaching practices +## Micro-Teaching Practices -Micro-teaching practices are the micro-skills that the teacher must attend in a Teaching Practice. In the coach's app, the micro-teaching practice is represented by questions to be answered by the Coach during a Class Observation and to be selected in the Coaching Session for the teacher to work on to improve. +Micro-Teaching Practices are more specific skills within a Teaching Practice. In the Coach's app, they are denoted by individual questions to be assessed during Class Observation and chosen during Coaching Sessions for targeted teacher improvement. diff --git a/docs/code/intro.md b/docs/code/intro.md index 6ed6f0b..f1dd6ba 100644 --- a/docs/code/intro.md +++ b/docs/code/intro.md @@ -2,16 +2,18 @@ sidebar_position: 100 --- -# About the code +# Source Code Overview -All our applications are available for cloning via SSH on GitHub, in a public organization called WBG-Coach. Each one has its peculiarities, and all its environment variables are in the respective repository files .env.example. +Our suite of applications, hosted under the public GitHub organization "WBG-Coach," is open for cloning via SSH. Each application has its unique aspects, and you can find the environment variables for each in the `.env.example` files in their respective repositories. -We request that any improvements be made through Pull Requests, and if you have any questions, feel free to open Issues. Thank you! +We encourage contributions through Pull Requests. If you encounter any issues or have queries, please don't hesitate to open Issues on GitHub. We appreciate your involvement and feedback! -# Links of source code +# Repository Links -All the code of Coach is available in the public repo: https://github.com/WBG-Coach
-The app code is: https://github.com/WBG-Coach/coach-app
-The docs code is: https://github.com/WBG-Coach/coach-doc
-The download page code is: https://github.com/WBG-Coach/coach-download
-The admin page code is: https://github.com/WBG-Coach/coach-admin
+Find below the links to the various components of the Coach project on GitHub: + +- **Main Coach Repository**: [https://github.com/WBG-Coach](https://github.com/WBG-Coach) +- **Coach App Source Code**: [https://github.com/WBG-Coach/coach-app](https://github.com/WBG-Coach/coach-app) +- **Coach Documentation Source Code**: [https://github.com/WBG-Coach/coach-doc](https://github.com/WBG-Coach/coach-doc) +- **Coach Download Page Source Code**: [https://github.com/WBG-Coach/coach-download](https://github.com/WBG-Coach/coach-download) +- **Coach Admin Page Source Code**: [https://github.com/WBG-Coach/coach-admin](https://github.com/WBG-Coach/coach-admin)