Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rephrase UG #175

Merged
merged 8 commits into from
Nov 15, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
layout: page
title: User Guide
---
**Foster Family** is a desktop app built for the **foster managers of cat and dog shelters** to help them perform **foster family management tasks**.
**Foster Family** is a desktop application built for **foster managers of cat and dog shelters** to help the **administrative management** of **foster families**.
H1410101 marked this conversation as resolved.
Show resolved Hide resolved

Here are some tasks which Foster Family can help you with:
* **Store and update** the important details of animal fosterers (people who temporarily care for an animal in their own homes)
* Search for a fosterer using _**any**_ detail you can remember of them
* **Gain insights** on the current status of fosterers
* **Store and update** the important details of animal fosterers (people who temporarily care for an animal in their own homes).
* **Search** for a fosterer using _any_ detail you can remember of them.
* **Gain insights** on the overall status of managed fosterers.

Foster Family is **optimised for use** via a Command Line Interface (CLI). This means you interact with it by typing commands in the command box. It also retains the benefits of a Graphical User Interface (GUI), allowing you to interact with the application through graphical components. If you can type fast, Foster Family can get things done faster than traditional GUI apps.
Foster Family is optimised for use via a **Command Line Interface (CLI)**. This means that you primarily interact with it by typing commands. It also retains the benefits of a Graphical User Interface (GUI), allowing you to interact with the application through graphical components. If you can type fast, Foster Family can get things done faster than traditional GUI apps.

This user guide contains **all** the commands available to you, along with **step-by-step explanations** and **examples** to help you master the use of Foster Family. If you are a _new user_, simply head over to [Quick Start](#quick-start) to begin your journey with us. For those who are _already acquainted_, you can refer to the [Table of Contents](#table-of-contents) below to navigate to your command of interest.
This document is a comprehensive guide to all the commands available to you, along with **step-by-step explanations** and **examples** to help you master the features Foster Family has to offer. If you are a _new user_, we recommend the [Quick Start](#quick-start) to begin your journey. For those who are _already acquainted_, you can refer to the [Table of Contents](#table-of-contents) below to navigate to a section that interests you.
H1410101 marked this conversation as resolved.
Show resolved Hide resolved

<div style="page-break-after: always;"></div>

Expand Down
Loading