dev: manual

[julianprester]

Update the user manual

The step summaries should give users an overview of the methodological aspects, indicate how they connect to the operations (implementation), and explain the essential data management aspects (e.g., state transitions, where files are stored/where they can be added/found). The basic preconditions (e.g., search terms), options (e.g., skipping the screen or completing it retrospectively, or in parallel) should be explained. More specific options (such as extensions/external tools) and best practices (maybe in the form of next steps, e.g., for init/share with the team) should be covered in the operations pages.

• Indicate that the specific implementation/functionality depends on the settings and link to the default settings/documentation (especially in the data operation)
• Merge feat: colrev retrieve/pdfs as high-level operations #92 before working on the issue.
• Determine default structure for summary pages of operations (e.g., description (illustration of state transitions and git diff/changes), parameters, and methodological sources)
• Clarify whether an operation leads to state transitions, adds records,. ..
• In each operation, we may link to the available package_endpoints (allowing users to understand how colrev can be extended)
• Mention that colrev merge focuses on prescreen/screen reconciliation (merging of parallel-independent, computational processing operations is not yet supported). For parallel independent data, users need to rely on git merges for now (for merging csvs, use daff, otherwise, reconciliation should focus on categorical data more than numerical data?)
• Check settings and describe the most relevant ones