-
Notifications
You must be signed in to change notification settings - Fork 131
Add user documentation for SLR tool #616
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
Closed
mannatjain11465-netizen
wants to merge
18
commits into
JabRef:main
from
mannatjain11465-netizen:slr-doc
Closed
Changes from 4 commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
2673fe7
Add user documentation for SLR tool
mannatjain11465-netizen 7d050b5
Fix markdownlint issues in SLR documentation
mannatjain11465-netizen 0e069a4
Fix markdownlint errors in AI documentation
mannatjain11465-netizen 74f1067
Fix markdownlint list spacing and cleanup
mannatjain11465-netizen 94f4654
Refine SLR documentation
mannatjain11465-netizen f3fb79e
Refine SLR documentation
mannatjain11465-netizen ebf7e02
Fix markdownlint issues
mannatjain11465-netizen 310bd20
Remove unrelated AI doc change from SLR PR
mannatjain11465-netizen ef0f435
Refine SLR documentation
mannatjain11465-netizen 61283f0
Fix markdownlint issues
mannatjain11465-netizen bb63b3b
Merge branch 'main' into slr-doc
koppor dd805cd
Add slr-example.png
mannatjain11465-netizen 27b2d8f
Add SLR example
mannatjain11465-netizen eb6c289
Resolved markdownlint errors
mannatjain11465-netizen 878cc08
Fix markdownlint errors
mannatjain11465-netizen afb1c76
Add example in the SLR doc
mannatjain11465-netizen 3bc736a
Fix markdownlint issues
mannatjain11465-netizen cbfd3ca
Fix markdownlint issues
mannatjain11465-netizen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| # Systematic Literature Review (SLR) Tool | ||
|
|
||
| The Systematic Literature Review (SLR) tool in JabRef helps researchers conduct structured and reproducible literature reviews. It supports defining research questions, creating search queries, selecting academic catalogs, and collecting references in an organized way. | ||
|
|
||
| This tool is especially useful for researchers who want to follow a systematic and transparent review methodology. | ||
|
|
||
| ## Starting a Systematic Literature Review | ||
|
|
||
| 1. Open JabRef. | ||
| 2. Navigate to **Tools → Start new systematic literature review**. | ||
| 3. The **Define study parameters** window opens. | ||
|
|
||
| ## Authors and Title | ||
|
|
||
| In the **Authors and Title** tab: | ||
|
|
||
| - Enter the **study title** | ||
| - Add at least one **author** | ||
|
|
||
| Both fields are required before starting the survey. | ||
|
|
||
| ## Research Questions | ||
|
|
||
| In the **Research Questions** tab: | ||
|
|
||
| - Define one or more research questions. | ||
| - These questions guide the scope and purpose of the review. | ||
|
|
||
| Each question should be clear and specific to ensure a focused search process. | ||
|
|
||
| ## Queries | ||
|
|
||
| In the **Queries** tab: | ||
|
|
||
| - Add search queries used to retrieve relevant publications. | ||
| - Queries typically combine keywords using Boolean operators such as: | ||
| - `AND` | ||
| - `OR` | ||
| - `NOT` | ||
|
|
||
| ## Catalogs | ||
|
|
||
| In the **Catalogs** tab: | ||
|
|
||
| - Select one or more academic catalogs to search in. | ||
|
|
||
| Examples include: | ||
|
|
||
| - ACM Portal | ||
| - arXiv | ||
| - DBLP | ||
| - Crossref | ||
| - IEEE Xplore | ||
|
|
||
| Choosing multiple catalogs increases coverage of the literature. | ||
|
|
||
| ## Finalize | ||
|
|
||
| In the **Finalize** tab: | ||
|
|
||
| - Select the directory where the study data will be stored. | ||
| - JabRef creates the study structure in this folder. | ||
|
|
||
| Make sure all required fields are completed: | ||
|
|
||
| - Study title | ||
| - At least one author | ||
| - At least one research question | ||
| - At least one query | ||
|
|
||
| Click **Start survey** to begin. | ||
|
|
||
| ## After Starting the Survey | ||
|
|
||
| Once the survey starts: | ||
|
|
||
| - JabRef runs the defined queries on the selected catalogs. | ||
| - Results are collected and stored in the study. | ||
|
|
||
| References can then be: | ||
|
|
||
| - Reviewed | ||
| - Filtered | ||
| - Tagged | ||
| - Exported | ||
|
|
||
| This supports a structured and reproducible review workflow. | ||
|
|
||
| ## Tips for Effective SLRs | ||
|
|
||
| - Use clear and specific research questions. | ||
| - Start with broader queries and refine them. | ||
| - Document all queries for reproducibility. | ||
| - Use Boolean operators effectively. | ||
|
|
||
| ## Summary | ||
|
|
||
| The SLR tool helps structure the entire review process: | ||
|
|
||
| 1. Define study metadata | ||
| 2. Add research questions | ||
| 3. Create search queries | ||
| 4. Select catalogs | ||
| 5. Run the survey and collect results | ||
|
|
||
| This makes literature reviews more systematic, transparent, and repeatable. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please submit unrelated fixes as seperate PR - to speed things up.