-
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
base: main
Are you sure you want to change the base?
Add user documentation for SLR tool #616
Conversation
koppor
left a comment
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.
OK, this reads like a nice AI-generated text.
Value comes in by:
- Screenshots
- Correct naming (I think, JabRef does not talk about "Tool" in the documentation)
- Correct content.
- More content than just listing what's in the UI
- Linking other areas of the documentation
- Same style as other areas of the documentation
| ## 1. Locate and accept the AI Privacy Policy | ||
|
|
||
| 1. Run JabRef, open a library, select an entry and open the [entry editor](../advanced/entryeditor/). There you will see tabs that have AI in their name.<br> | ||
| 1. Run JabRef, open a library, select an entry and open the [entry editor](../advanced/entryeditor/). There you will see tabs that have AI in their name. |
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.
|
|
||
| This ensures that the study contains sufficient metadata and search configuration before data collection starts. | ||
|
|
||
| --- |
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.
Clear sign of AI geneation.
koppor
left a comment
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.
concrete example still messing.
|
|
||
| The **Start survey** button becomes available only after the study definition is complete. The definition must include: | ||
|
|
||
| * Study title |
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 provide an example. A concrete study.
Do not just re-state what's shown in JabRef
koppor
left a comment
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.
This issue is NOT a quick win.
Use an existing SLR as example - or think of your own.
Maybe, it is easy to cover a part of https://link.springer.com/article/10.1007/s00607-025-01432-z in the documentation?
| Research questions define the scope of the study within JabRef. | ||
| They help relate queries and later screening decisions to the study purpose. | ||
|
|
||
| Each question should be: |
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.
Example still missing
|
Thanks for the feedback! Just to confirm that I understand correctly, you’d like the documentation to include a more realistic example that reflects how an actual published study is structured rather than a simplified illustrative scenario. I'll update the example accordingly |
Yes. And please double-check https://github.com/JabRef/jabref/blob/main/AI_USAGE_POLICY.md#guidelines-for-using-ai-tools |
|
Will it be fine if the screening numbers are illustrative, to show how papers get filtered through the stages...and not from a real study since it's only an example or am I supposed to pick them from an actual study? |
Do a mix of both. - I fear that "illustrative" could mean, you do "ABC", "DEF" and random stuff. This is not OK. - You are invited to come up with a "spontaneous" example. Maybe based on our "Chocolate" world: https://github.com/JabRef/jabref-demonstration-libraries/tree/main/chocolate. Not holistic, but the mains steps should be in. |
Summary
This PR adds user documentation for the Systematic Literature Review (SLR) tool in JabRef.
The page explains how users can perform a structured literature review using the SLR feature, including:
This documentation is aimed at end users and helps make the SLR feature more discoverable and easier to use.
Motivation
The SLR tool is a powerful feature, but users may not know how to use it effectively. This documentation provides step-by-step guidance to support systematic and reproducible literature reviews.
Type of Change
Checklist
user-documentationrepositoryAlso fixed pre-existing markdownlint issues in how-to-enable-and-use-ai-features.md so CI passes