Welcome to Academic Workflow Suite! Whether you're marking your first assignment or looking to optimize your existing workflow, this guide will help you get up and running quickly.
What You'll Learn
- Installing and configuring Academic Workflow Suite
- Creating your first project and importing assignments
- Using AI-assisted feedback generation
- Customizing rubrics and feedback templates
- Exporting feedback to your LMS
Prerequisites
Before you begin, make sure you have:
- A computer running macOS 11+, Windows 10+, or Linux (kernel 4.15+)
- At least 4GB of RAM (8GB recommended)
- 500MB of free disk space
- Optional: Access to your LMS (Moodle, Canvas, etc.) for integration
Step 1: Installation
The quickest way to get started is using our one-line installer. Open your terminal and run:
# macOS and Linux
curl -sSL https://install.academic-workflow.org | bash
# Windows (PowerShell)
irm https://install.academic-workflow.org/windows | iex
Alternatively, you can download the installer for your platform and run it manually. The installer will:
- Download the latest version of AWS
- Install necessary dependencies
- Set up the command-line tools
- Launch the setup wizard
Step 2: Initial Configuration
When you first launch AWS, you'll be greeted by the setup wizard. Let's go through each step:
2.1 Choose Your Language
Select your preferred interface language. AWS supports 20+ languages including English, Spanish, French, German, Chinese, and more.
2.2 Set Up Data Storage
Choose where AWS will store your data. The default location is ~/AcademicWorkflow,
but you can select any folder. All data is encrypted with your passphrase.
2.3 Configure AI Features
Decide which AI model to use:
- Lightweight (default): 200MB, faster processing, good for most use cases
- Advanced: 2GB, higher quality feedback, recommended for complex assignments
- Manual only: No AI, all feedback written manually
You can always change this later in Settings.
2.4 Optional: LMS Integration
If you use a Learning Management System, you can set up integration now or skip this step and configure it later. See our LMS integration guide for detailed instructions.
Step 3: Create Your First Project
Projects in AWS help you organize courses, assignments, and students. Let's create one:
# Create a new project
aws init "Introduction to Computer Science"
# Or use the GUI: File β New Project
You'll be prompted to enter:
- Project/course name
- Academic year or semester
- Optional: Default rubric template
Step 4: Import Assignments
There are several ways to import student submissions:
Method 1: LMS Integration (Recommended)
If you've configured LMS integration:
# List available assignments
aws lms list
# Import a specific assignment
aws lms import --assignment "Essay 1: Critical Analysis"
Method 2: Bulk Upload
If you have files in a folder:
# Import all PDFs from a folder
aws import --folder ~/Downloads/student-essays/ --assignment "Essay 1"
Method 3: CSV Import
If you have a CSV file with student info and file paths:
# CSV format: student_name,email,file_path
aws import --csv assignments.csv
Step 5: Create or Load a Rubric
Rubrics ensure consistent grading. AWS comes with templates for common assignment types:
# List available templates
aws rubric list-templates
# Create from template
aws rubric create --template essay --name "Critical Analysis Rubric"
# Or create a custom rubric
aws rubric create --name "My Custom Rubric"
You can also create rubrics using the visual editor in the GUI. Here's an example rubric structure:
name: "Essay Rubric"
total_points: 100
criteria:
- name: "Thesis & Argument"
weight: 35
levels:
- score: 5
description: "Exceptional: Clear, original thesis with sophisticated argument"
- score: 4
description: "Strong: Clear thesis with well-developed argument"
- score: 3
description: "Adequate: Thesis present with basic argument"
# ... more levels
- name: "Evidence & Analysis"
weight: 30
# ... criteria levels
Step 6: Mark Your First Assignment
Now for the exciting partβusing AI to help with marking!
Single Assignment Marking
# Mark a specific student's work
aws mark --assignment "Essay 1" --student "john.doe@university.edu" --rubric "Critical Analysis Rubric"
This will:
- Load the student's submission
- Analyze it against your rubric
- Generate AI feedback suggestions
- Open the feedback editor for your review
Understanding the Feedback Editor
The feedback editor shows:
- Left pane: Student submission
- Right pane: AI-generated feedback (editable)
- Bottom pane: Rubric scores and justifications
Reviewing and Editing Feedback
Always review AI-generated feedback. Look for:
- Accuracy: Does it correctly identify strengths and weaknesses?
- Tone: Is it constructive and encouraging?
- Specificity: Does it provide actionable suggestions?
- Personalization: Can you add specific examples or personal notes?
Make edits directly in the editor. The AI learns from your corrections to improve future suggestions.
Step 7: Export and Share Feedback
Once you're happy with the feedback:
Export to LMS
# Sync grades and feedback back to your LMS
aws lms sync --assignment "Essay 1"
Export as PDF
# Generate PDF feedback files
aws export --format pdf --output ~/feedback-pdfs/
Export as CSV
# Export grades and comments to spreadsheet
aws export --format csv --output grades.csv
Next Steps
Congratulations! You've marked your first assignment with Academic Workflow Suite. Here's what to explore next:
Common Questions
How accurate is the AI feedback?
AI feedback serves as a starting point, not the final product. In our testing with 500+ educators, users report 85-95% satisfaction with AI suggestions as a draft. You should always review and personalize feedback before sharing with students.
Can I use AWS offline?
Yes! All core features work completely offline. Internet is only required for LMS sync and software updates.
How do I backup my data?
Use aws backup create to create encrypted backups. You can also enable
automatic cloud sync to Dropbox, Google Drive, or other providers.
Can multiple instructors collaborate?
Yes! Use team mode to share rubrics and coordinate marking. Each instructor maintains their own secure environment.
Getting Help
Stuck on something? Here's where to get help:
We hope this guide helps you get started with Academic Workflow Suite. Remember, the goal is to save you time while improving feedback quality. Start with one assignment, get comfortable with the workflow, and gradually incorporate more features.
Happy marking! π