diff --git a/user/English/aside_activities.md b/user/English/aside_activities.md new file mode 100644 index 0000000..c45eeb7 --- /dev/null +++ b/user/English/aside_activities.md @@ -0,0 +1,32 @@ +/newpage + +# Side activities + +To allow a user to also keep track of activities that are not directly related to a support trajectory or to a person, there is a side activity section. + +A side activity could be a team meeting, a training, but also a phone call or email. + +## Listing page + + + +A user can navigate to his/her list of side activities from within their user menu by clicking on <**My side activities**>. Similar to other sections of the Chill app, you will find here a list that offers a first quick overview of each activity. You can view the activity in more detail, edit, or delete it. + + +## Creating a side activity + + + +The form fields of a side activity are self-explanatory. It is important to note however that a user can create a side activity for another user. Multiple users can also be linked, think of a meeting for example. + +A side activity can be created for the future, but they can also still be created for activities that already took place. As such it shouldn't be seen as a planning tool, but more to keep record of side activities. + +All fields are required, except for any additional note you might want to add. + +## Detail page + + + +Within the detail page the most important thing to note is the option to **duplicate** a side activity. For example, a meeting that is held weekly with more or less the same people can therefore easily be duplicated, while still allowing modifications to be made. + + diff --git a/user/English/documents.md b/user/English/documents.md new file mode 100644 index 0000000..8a3510b --- /dev/null +++ b/user/English/documents.md @@ -0,0 +1,3 @@ +/newpage + +TODO: translate from french \ No newline at end of file diff --git a/user/English/social_actions.md b/user/English/social_actions.md new file mode 100644 index 0000000..78cfb0b --- /dev/null +++ b/user/English/social_actions.md @@ -0,0 +1,3 @@ +/newpage + +TODO \ No newline at end of file diff --git a/user/English/support_trajectory.md b/user/English/support_trajectory.md new file mode 100644 index 0000000..5cb4bbd --- /dev/null +++ b/user/English/support_trajectory.md @@ -0,0 +1,165 @@ +/newpage + +# Social support trajectory + +Providing meaningful social support is often an intricate combination of goals, actions, involved actors, documents, etc... With its social support module, Chill aims to give it's users a tool which they can keep track of trajectories. + +You can look at it as the third big module within the application. Like the person and household modules it can be easily identified by the banner at the top of the screen, which is in this case **gray** in color. + +## Creation of a social support trajectory + + + +A new trajectory can be created from the section menu. Doing so will direct you to a blank trajectory form for you to fill-out. + +> Sections > Create a new trajectory + + +A trajectory can also be created from within a person file and will immediately link it to this person. You will see the person added in the first section **concerned persons** +> Yellow person menu > Trajectories > Create a trajectory button + +### Different states of a trajectory + +It is important to distinguish three main states for a trajectory. A badge can be found in the top right corner of the banner or list-item to identify this state. + +* **DRAFT**: the trajectory form has missing information and can therefore not be confirmed (badge color: gray) * +* **CONFIRMED**: all required information has been provided and further actions, activities,... can be added (badge color: dark blue). +* **CLOSED**: the social support trajectory has come to closure, the reason can be defined (badge color: red). + +Within your user menu you will find a menu entry to direct you to, + +* a listing page of **all** the trajectories to which you are the referrer. +* a listing page of all your **DRAFT** trajectories (ones you created, but have not yet confirmed). + +While the above three are considered the main states, there are additional properties that distinguish the state of a trajectory. They are the following, + +* **Confidential**: A confidential trajectory can only be viewed by the referrer. Other users will not have access to it's information. +* **Intensity**: TODO The intensity can be set to *regular* or *punctual* +* **Emergency**: This state can be toggled when urgent actions are required within this trajectory. + +### Required information + +The information required to **confirm** a trajectory is the following: + +* It is linked to at least one [concerned person](#concerned-person). +* It has at least one linked [social issue](#social-issue). +* It is assigned to at least one [service](#service). +* It has to be [localised](#trajectory-localisation). + +All of these requirements are listed at the bottom of the form when you have failed to fulfill them. This serves as a reminder to what you should do in order to confirm the trajectory. + +### Concerned person + +A trajectory can be put started to provide support to multiple persons (eg. support is given to a mother and her two children). + +### Trajectory localisation + +Every trajectory **has** to be localised and this can be done in one of two ways. + +1. You can indicate a temporary address by clicking the designated button. The address will not automatically be adapted when a concerned person moves. Therefore a message is displayed to remind you as a user that the second option, here listed, is preferable. + +2. You can link it to a concerned person's **home address** by clicking the map-marker icon in the concerned persons section. If the person moves it will also be automatically adapted within the trajectory. + +__Note__: While a trajectory is linked to a concerned person's address... +* it is not possible to dissociate this person from the trajectory. +* the person cannot be moved from a household without indicating another address. + + +#### Why localize a trajectory ? + +Localising a trajectory allows for the following: + +* The automatic assignment of a referrer. +* Inclusion in the list of trajectories to be discussed within meetings held by concerning services. +* The generation of localised statistics. +* The management of access rights. + +### Origin of the application for support + +Within this section you will find a pre-defined list of possible origins (eg. the application was done by telephone) + +### Administrative localisation + +TODO + +### The applicant + +This can be an already existing person/thirdparty or a new applicant can be created from within the search modal. Click on the button **** to do so. + +### Social issue + +Using the dropdown menu multiple social issues can be identified. Link at least one to be able to confirm the trajectory. + +### Services + +Identify at least one service that is concerned with this trajectory. Multiple services can be selected. This will have an impact on who has the right to access the trajectory files. + +### Referrer + +The referrer is the colleague to whom you can refer yourself concerning this trajectory. They are responsible for the follow-up and they have specific rights linked to the state of the trajectory. +* They can mark it as confidential. +* They can mark it as urgent. +* They can change the intensity. + +__Note__: These three states cannot be modified if a trajectory does not have a referrer assigned. +Likewise a referrer cannot be removed from a confidential trajectory. + +### External partners + +A trajectory is setup to provide support to one or more concerned persons. Naturally, there may also be one or more thirdparties or persons involved to offer this support. These partners can be added in this section by searching for their name. +When a partner does not yet exist they can be created from within the search modal by pressing the button ****. + +## Trajectory overview + + + +The overview page assembles the most important information and latest activity within a trajectory, allowing you to take certain quick actions like clicking on associated person badges, linked activities or social actions, sending a new notification, etc... + +In short it is the trajectory dashboard from where you will navigate to specific sections. + +## Trajectory history + + +TODO + +## Social support actions + + + +Within a trajectory plenty of actions will be taken to realize the support. Please read the documentation about [social actions](/user/English/social_actions.md) for in detail information. + +## Comments + + + +Comments can be added to a trajectory to notify co-workers of additional information for which there may not be a designated section. A comment can be **pinned** to the trajectory dashboard by clicking on the flag icon. + +__note__: Only one comment can be pinned to the dashboard, but all comments will remain available within the comment section to view,modify, re-pin, or delete. + +## Tasks + + + +Just as within the person module, tasks can be created and assigned within a trajectory. Please read the documentation about [tasks](/user/English/tasks.md) for in detail information. + +## Documents + + + +Just as within the person module, documents can be attached to a trajectory. The only difference here is that a trajectory document can also be generated from a template. This template can be selected from the dropdown menu. + +Please read the documentation about [documents](/user/English/documents.md) for in detail information. + +## Close a trajectory + + + +At any time a trajectory can be closed by clicking on the sidebar menu entry ****. + +You will be taken to a small form in which you can specify the date of closure and the reason. + +## Re-open a trajectory + +When a trajectory is closed the menu will adapt itself to offer the user the possibility to re-open it. No further actions are required after clicking this button. + + diff --git a/user/English/tasks.md b/user/English/tasks.md new file mode 100644 index 0000000..25e8a87 --- /dev/null +++ b/user/English/tasks.md @@ -0,0 +1,41 @@ +/newpage + +# Tasks + +## Listing page + + + +Clicking on the <**task**> menu entry in the person or trajectory side-menu will bring you to the listing page. + +Here you have an overview of all tasks related to this particular person or trajectory. + +At the top of the list you find a searchbar and several filtering options, + +* Future tasks or tasks without due date +* Tasks that are almost due +* Tasks with a passed due date +* New tasks +* Tasks that are in progress +* Closed tasks +* Removed tasks + +Listed tasks are displayed with their title, a badge identifying the state in which the task can be found (new, in progress, closed,...) and their starting date, date on which a reminder will be sent and their due date. Your task reminders can be found on the homepage widget, or displayed in your user menu. + +A separate user menu entry will take you directly to a listing page of all your tasks that have surpassed their due date and have not been closed. This menu entry is easily identifiable by the exclamation mark triangle (!). + +## Creating a new task + + + +To create a new task you will be given a form to fill in. +The fields are self-explanatory but do note that only the title is required. + +## Detail page + + + +You can view the task in more detail by clicking on the **eye** icon button. On the detail page you will see the description of the task, but also the task history. The history gives you an overview of state changes and who undertook them on which day. This allows users to easily keep track of tasks. + +Within the detail page, as well as in the listing page you have the ability to navigate to an edit page where you can modify the task. A task can also be deleted and it's current state can be changed using the dropdown button <**change state**>. + diff --git a/user/English/thirdparty.md b/user/English/thirdparty.md index 9c96fac..f6f5aba 100644 --- a/user/English/thirdparty.md +++ b/user/English/thirdparty.md @@ -1,3 +1,4 @@ +/newpage # Thirdparty Within the context of social support you will most likely work together with plenty of professional external partners. @@ -5,7 +6,7 @@ Chill allows you to easily link them to a user and their social support trajecto All thirdparty information can be consulted by going to the section menu in the top-right corner and selecting **thirdparties**. -At the top of the list a searchbar allows you to easily find the thirdparty you are looking for on the baiss of their name. +At the top of the list a searchbar allows you to easily find the thirdparty you are looking for on the basis of their name. ## Create a thirdparty diff --git a/user/img/Screenshot from 2022-03-16 17-44-19.png b/user/img/Screenshot from 2022-03-16 17-44-19.png new file mode 100644 index 0000000..598a0c4 Binary files /dev/null and b/user/img/Screenshot from 2022-03-16 17-44-19.png differ diff --git a/user/img/Screenshot from 2022-03-16 17-44-47.png b/user/img/Screenshot from 2022-03-16 17-44-47.png new file mode 100644 index 0000000..88806f8 Binary files /dev/null and b/user/img/Screenshot from 2022-03-16 17-44-47.png differ diff --git a/user/img/Screenshot from 2022-03-16 17-47-10.png b/user/img/Screenshot from 2022-03-16 17-47-10.png new file mode 100644 index 0000000..ac561f7 Binary files /dev/null and b/user/img/Screenshot from 2022-03-16 17-47-10.png differ diff --git a/user/img/Screenshot from 2022-03-16 17-47-59.png b/user/img/Screenshot from 2022-03-16 17-47-59.png new file mode 100644 index 0000000..226f98e Binary files /dev/null and b/user/img/Screenshot from 2022-03-16 17-47-59.png differ diff --git a/user/img/Screenshot from 2022-03-16 17-49-27.png b/user/img/Screenshot from 2022-03-16 17-49-27.png new file mode 100644 index 0000000..e1eb182 Binary files /dev/null and b/user/img/Screenshot from 2022-03-16 17-49-27.png differ diff --git a/user/img/Screenshot from 2022-03-16 17-49-57.png b/user/img/Screenshot from 2022-03-16 17-49-57.png new file mode 100644 index 0000000..dbea5ca Binary files /dev/null and b/user/img/Screenshot from 2022-03-16 17-49-57.png differ diff --git a/user/img/Screenshot from 2022-03-16 17-50-14.png b/user/img/Screenshot from 2022-03-16 17-50-14.png new file mode 100644 index 0000000..f0f268d Binary files /dev/null and b/user/img/Screenshot from 2022-03-16 17-50-14.png differ diff --git a/user/img/Screenshot from 2022-03-16 17-50-34.png b/user/img/Screenshot from 2022-03-16 17-50-34.png new file mode 100644 index 0000000..9027b38 Binary files /dev/null and b/user/img/Screenshot from 2022-03-16 17-50-34.png differ diff --git a/user/img/Screenshot from 2022-03-16 17-50-49.png b/user/img/Screenshot from 2022-03-16 17-50-49.png new file mode 100644 index 0000000..fa69133 Binary files /dev/null and b/user/img/Screenshot from 2022-03-16 17-50-49.png differ diff --git a/user/img/Screenshot from 2022-03-16 17-51-26.png b/user/img/Screenshot from 2022-03-16 17-51-26.png new file mode 100644 index 0000000..a51825c Binary files /dev/null and b/user/img/Screenshot from 2022-03-16 17-51-26.png differ diff --git a/user/img/Screenshot from 2022-03-16 17-51-41.png b/user/img/Screenshot from 2022-03-16 17-51-41.png new file mode 100644 index 0000000..bf8fa58 Binary files /dev/null and b/user/img/Screenshot from 2022-03-16 17-51-41.png differ diff --git a/user/img/Screenshot from 2022-03-16 17-51-56.png b/user/img/Screenshot from 2022-03-16 17-51-56.png new file mode 100644 index 0000000..b7759df Binary files /dev/null and b/user/img/Screenshot from 2022-03-16 17-51-56.png differ diff --git a/user/img/Screenshot from 2022-03-16 17-52-39.png b/user/img/Screenshot from 2022-03-16 17-52-39.png new file mode 100644 index 0000000..0269820 Binary files /dev/null and b/user/img/Screenshot from 2022-03-16 17-52-39.png differ diff --git a/user/img/Screenshot from 2022-03-17 09-54-27.png b/user/img/Screenshot from 2022-03-17 09-54-27.png new file mode 100644 index 0000000..50da863 Binary files /dev/null and b/user/img/Screenshot from 2022-03-17 09-54-27.png differ diff --git a/user/img/Screenshot from 2022-03-17 10-41-16.png b/user/img/Screenshot from 2022-03-17 10-41-16.png new file mode 100644 index 0000000..d4ed272 Binary files /dev/null and b/user/img/Screenshot from 2022-03-17 10-41-16.png differ diff --git a/user/img/Screenshot from 2022-03-17 10-41-42.png b/user/img/Screenshot from 2022-03-17 10-41-42.png new file mode 100644 index 0000000..39e2354 Binary files /dev/null and b/user/img/Screenshot from 2022-03-17 10-41-42.png differ diff --git a/user/img/Screenshot from 2022-03-17 10-42-12.png b/user/img/Screenshot from 2022-03-17 10-42-12.png new file mode 100644 index 0000000..a95377b Binary files /dev/null and b/user/img/Screenshot from 2022-03-17 10-42-12.png differ