Skip to content

Commit 9c75409

Browse files
committed
Merge branch 'main' of github.com:openqda/user-docs
2 parents 2081d3e + f8064c0 commit 9c75409

2 files changed

Lines changed: 61 additions & 9 deletions

File tree

docs/intro.md

Lines changed: 56 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,74 @@ sidebar_position: 1
44

55
# Introduction to OpenQDA
66

7-
Let's discover **OpenQDA in less 5 minutes**.
7+
Let's discover **OpenQDA in under 10 minutes**.
88

99
## Register a new account
1010

11-
TBD
11+
Head over to [the OpenQDA website at openqda.org](https://openqda.org).
12+
13+
IMG
14+
Click on the orange **Register** button.
15+
16+
IMG
17+
Now fill out the register form with your name or pseudonym, your email and a secure password.
18+
Then click the **Register** button.
19+
20+
IMG
21+
A verification email should appear in your email program. Please click the link for verification.
22+
23+
IMG
24+
Now that you are verified, you can either edit your profile or create a project.
25+
26+
## Create your first project
27+
28+
Your work in OpenQDA is organized in projects.
29+
30+
IMG
31+
Fill out the project form and give Your first project a nice name (and optionally write a description).
32+
Then click the **Create a new project** button.
33+
Your new project is created, and you go to the project tab. If you want to go back and create more projects or switch between projects, click on the little blue owl in the left corner (this will change in the next version of OpenQDA, because it is not self-evident).
34+
35+
## Manage your project
36+
37+
You are now in the project tab of OpenQDA. Here you can change the project name, project description and even delete your project.
38+
In the sub tab **Collaboration** you can set up your project to work with others. We skip this part for now.
39+
In the sub tab **Codebook** you can manage different codebooks, share, reuse and import codebooks from other people. We skip this part also.
40+
In the sub tab **History** you see a full log of all actions within the project.
41+
42+
BTW, if you want to edit your profile picture, click on the profile picture in the right upper corner, right now it should be your initials, and select profile. Now you can select a new photo for your profile, change your name or password.
1243

1344
## Upload and prepare a text file
1445

15-
TBD
46+
Let's upload and prepare our first text file for coding (right now, OpenQDA only supports RTF and TXT files - NO .doc, .docx or .pdf files!).
47+
Please click on the **Preparation** tab at the top of the page.
48+
49+
IMG
50+
Now you can import TXT or RTF files into OpenQDA (as OpenQDA has a plug-in architecture, we or other people of the community may create import plug-ins for other file formats).
51+
Click the **Import** button to select a TXT or RTF file. Click on the title of the document to see the contents of the file in the editor in the right pane. Now you can edit the document.
52+
53+
You can also create new text documents when you click **New file**. You can then paste your text contents into the new document.
54+
55+
When you are ready with editing, you can press the **Lock and Code** button to lock the file and start coding.
1656

1757
## Coding the text
1858

19-
TBD
59+
Now you are in the **Coding** tab section.
60+
In the left pane there is your text (you can switch between texts with the blue menu button).
61+
On the right you see your codes pane. Right now you need to activate a codebook to start coding.
62+
If you do not have any codes in your code book, let's create one by clicking on **Add Code**.
63+
A new code category appears. You can edit it's name by double clicking on the text.
64+
You can also create a note (click on the pen icon).
65+
To create subcodes or move your codes, click on the mini-menu button of the code.
66+
You can code text in 3 ways:
67+
- make a text selection and use right mouse click / contextual menu click and select a code
68+
- drag the text selection to the code
69+
- drag the code to the text selection
70+
All dragging only works on Macs and PCs, not on smartphones or tablets (we are working on it).
2071

2172
## Analysis
2273

23-
TBD
74+
To do your analysis, go to the **Analysis** tab section.
2475

2576
## What next?
2677

src/components/HomepageFeatures/index.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ const FeatureList = [
88
img: 'img/data_collection.png',
99
description: (
1010
<>
11-
Some line on data collection
11+
Here you upload, create or import data.
12+
In the Early Access, you can only import .txt and .rtf file types.
1213
</>
1314
),
1415
},
@@ -17,7 +18,7 @@ const FeatureList = [
1718
img: 'img/data_preparation.png',
1819
description: (
1920
<>
20-
Some lines on data preparation
21+
Here you prepare your data, e.g. you fix typos in your transcripts.
2122
</>
2223
),
2324
},
@@ -26,7 +27,7 @@ const FeatureList = [
2627
img: 'img/data_coding.png',
2728
description: (
2829
<>
29-
Some lines on coding
30+
Here you code your data and create your code systems.
3031
</>
3132
),
3233
},
@@ -35,7 +36,7 @@ const FeatureList = [
3536
img: 'img/data_analysis.png',
3637
description: (
3738
<>
38-
Some lines on analysis
39+
Here you analyse your coded data.
3940
</>
4041
),
4142
}

0 commit comments

Comments
 (0)