diff --git a/documentation/GETTING_STARTED.md b/documentation/GETTING_STARTED.md deleted file mode 100644 index 1f519766..00000000 --- a/documentation/GETTING_STARTED.md +++ /dev/null @@ -1,3 +0,0 @@ -# Getting Started `Work in Progress` - -Here we are planning to collect FAQ for new users and contributors... diff --git a/documentation/INSTALLATION.md b/documentation/INSTALLATION.md new file mode 100644 index 00000000..98b6856d --- /dev/null +++ b/documentation/INSTALLATION.md @@ -0,0 +1,44 @@ +# Installation & Usage as User +Anyone may install PersonalAnalytics on their Windows or macOS device to non-intrusively collect computer interaction data, and analyze their activity, time spent and work habits for themselves. In the future, once we'll re-introduce the Retrospection (i.e. visualizations of the collected and self-reported data), it will be much easier to gain insights again. + +## How to install PersonalAnalytics on Windows +1. Visit https://hasel.dev/pa +2. Select the Windows version (exe-file) +3. Wait for the download to complete +4. Allow the install-file (exe) to be downloaded in case your browser blocks it +5. Double click the downloaded file and follow the installer +6. Select "Run PersonalAnalytics" +7. Follow the Onboarding wizard that explains the study, collected data and how to use PersonalAnalytics +8. Access PersonalAnalytics anytime through the context-menu in the taskbar icon + +The following video shows the steps in action: + +[![How to install PersonalAnalytics on Windows](https://markdown-videos-api.jorgenkh.no/youtube/70bempaQYFk)](https://youtu.be/70bempaQYFk) + + +## How to install PersonalAnalytics on macOS + + + +## Using PersonalAnalytics +For the majority of the time, PersonalAnalytics is running nonintrusively in the background. +The onboarding guide as well as about page of the app explain the purpose of the current research study that is using PersonalAnalytics, the data that is collected and how data analysis will be performed. + +image + +### Experience Sampling +In case the researchers enabled it, it might occasionally show an a self-reporting question that you can answer, or skip. +image + +### Accessing the App +In the taskbar (on Windows) or the menubar (on macOS), you can access all the necessary features, such as opening the About page, exporting your data, accessing the locally stored data, or receiving help. + +image + +### Data Export +The researchers might ask you to share the collected data with them for data analysis as part of their research project. To that purpose, click "Export Data" in the taskbar (on Windows) or menubar (on macOS) and follow the wizard. Note the infrmation on [data collection and privacy](PRIVACY.md). + +image + +### Questions +In case of questions, contact the researchers who asked you to install PersonalAnalytics. You find their email in the study description or by clicking "Get Help" in the context menu. diff --git a/documentation/videos/PersonalAnalytics_Installation_Windows.mp4 b/documentation/videos/PersonalAnalytics_Installation_Windows.mp4 new file mode 100644 index 00000000..c0e64d2b Binary files /dev/null and b/documentation/videos/PersonalAnalytics_Installation_Windows.mp4 differ