Skip to content

Commit aaf2d44

Browse files
authored
Merge pull request #43 from ppival/patch-20
Fix formatting and punctuation in AI-Assisted Coding doc
2 parents 0697b9b + 78f76c5 commit aaf2d44

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

docs/doc/en/4.2.-AI-Assisted-Coding.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ path: 4.2.-AI-Assisted-Coding
88
QualCoder’s built-in AI features (version 3.6 and up) can assist the coding process in various ways:
99

1010
- **AI Search:** Leverage the AI's ability to quickly analyze large amounts of text to find and explore specific topics or concepts within your corpus.
11-
- **Search for concepts, not keywords:** QualCoder uses a combination of semantic search technologies and Large Language Models like GPT-4. As a result, you don’t need to enter exact keywords but can also search for much more abstract concepts, e.g. "changing gender roles" or "recognition in the workplace".
11+
- **Search for concepts, not keywords:** QualCoder uses a combination of semantic search technologies and Large Language Models like GPT-4. As a result, you don’t need to enter exact keywords but can also search for much more abstract concepts, e.g., "changing gender roles" or "recognition in the workplace".
1212
- **Interpret your data interactively with the AI:** The AI not only suggests relevant data but also provides interpretation, offering a different perspective that can enrich your understanding of the data.
1313
- **Adapt it to your methodology:** Direct the AI’s analysis by choosing from several predefined prompts or creating your own.
1414
- **Assisted, not automated coding:** Unlike the keyword-based [auto coding](https://qualcoder-org.github.io/doc/en/4.1.-Coding-Text#auto-code), this is not an automated process. You must review the AI's suggestions.
@@ -19,8 +19,8 @@ Note that "AI Assisted Coding" is not a method in its own right; it's a set of t
1919
- The AI must be enabled, fully loaded, and ready for new queries (see the status bar for current state).
2020
- It is **highly recommended** to use the project memo (Menu "AI > Project Memo") to include a short description of your project's research topics, questions, objectives, and the empirical data collected. This information will accompany every prompt sent to the AI, resulting in much more targeted results.
2121

22-
## Start AI Assisted Coding
23-
AI assisted coding is integrated into the text coding workspace. Start it by clicking on "Coding > AI assisted coding" or, if you already are in the text coding workspace, select the "AI Assistance" tab on the left. Then click on "Start AI Search."
22+
## Start AI-Assisted Coding
23+
AI-assisted coding is integrated into the text coding workspace. Start it by clicking on "Coding > AI-assisted coding" or, if you are already in the text coding workspace, select the "AI Assistance" tab on the left. Then click on "Start AI Search."
2424

2525
![Screenshot AI Assistance Tab](https://github.com/user-attachments/assets/1eeca42f-2e4e-48a6-aca7-68e4b13df6c4)
2626

@@ -50,33 +50,33 @@ The analytic prompt instructs the AI how to examine your data. Select it in the
5050
<img src="https://github.com/user-attachments/assets/83ab0d49-782d-420d-8088-9dec78e3e28e" width=1000em alt="Analytic Prompt Selection">
5151

5252

53-
**QualCoder offers a range of analytic prompts for different approaches.** These allow, for instance, to modify the AI search to be either very open, interpretative and inclusive ("Open search" prompt) or to be more focused, adhering to predefined coding rules outlined in the code’s memo ("content analysis" prompt).
53+
**QualCoder offers a range of analytic prompts for different approaches.** These allow, for instance, to modify the AI search to be either very open, interpretative, and inclusive ("Open search" prompt) or to be more focused, adhering to predefined coding rules outlined in the code’s memo ("content analysis" prompt).
5454

5555
**Explore these prompts** by hovering your mouse over the items in the drop-down list. Click on "Edit" to [edit the analytic prompts or define your own](https://qualcoder-org.github.io/doc/en/6.2.-AI-Prompt-Library) (advanced option).
5656

5757
### 3) Filter: Narrow Your Search Down
5858
By default, the complete corpus of textual data in the current project is explored. If you want to limit the search to certain **documents** or **cases**, you can select them on the right side of the window (Ctrl + Click to select multiple). You can also define a filter based on selected **attribute variables.**
5959

60-
## The Process of AI Assisted Coding
60+
## The Process of AI-Assisted Coding
6161
First, perform the AI Search. This is a two-step process:
6262

6363
**Step 1:** The AI queries its local database for potentially relevant data in your corpus.
6464

6565
**Step 2:** This data is then sent to the large language model for a detailed analysis based on the selected prompt.
6666

67-
Please be patient as it might take some time for the initial results to appear. Clicking on a result loads the document in the main window and highlights the relevant quote. Make sure to also look at the text surrounding the quote to understand its context.
67+
Please be patient as it might take some time for the initial results to appear. Clicking on a result loads the document in the main window and highlights the relevant quote. Also make sure to look at the text surrounding the quote to understand its context.
6868

6969
### Working through the Results
7070

7171
You can **code the selected text** as you would any other text in the [code-text workspace](https://qualcoder-org.github.io/doc/en/4.1.-Coding-Text). Expand or modify the selection as needed.
7272

73-
You can also view the **AI's interpretation** by hovering your mouse over a result in the list on the left, which will display a tooltip window. If you choose to code the text, you will have the option to add the AI's interpretation as a memo to the coding.
73+
You can also view the **AI's interpretation** by hovering your mouse over a result in the list on the left, which will display a tooltip window. If you choose to code the text, you can add the AI's interpretation as a memo to the code.
7474

7575
![AI interpretation](https://github.com/user-attachments/assets/83e4e641-1e9d-4b2c-b80d-6c6e5b7c2e97)
7676

7777
When you reach the **end of the list,** you'll often see a "find more" link, which means that more data from the first step of the search is available for closer inspection. Click on this link to examine the next 10 pieces of data.
7878

79-
QualCoder uses a **ranking algorithm** to display the most relevant results at the top of the list. Note that this algorithm is not perfect, you may still find interesting data further down the list.
79+
QualCoder uses a **ranking algorithm** to display the most relevant results at the top of the list. Note that this algorithm is not perfect; you may still find interesting data further down the list.
8080

8181
Over time, however, the results returned by the AI will begin to **diverge from the original topic** and become less and less relevant. This is the point where you should stop the investigation and move on to the next topic or code. You don't need to click "find more" until there is absolutely no data left to analyze from step one of the search. Compare this to a Google search: There's no need to click through every single page of results if you already understand what you want to know.
8282

0 commit comments

Comments
 (0)