Documentation

Quick Start Guide

Get started with Academic Workflow Suite in 5 minutes.

Installation

# macOS/Linux
curl -sSL https://install.academic-workflow.org | bash

# Verify installation
aws --version

Basic Usage

# Create a new project
aws init my-course

# Import assignments from CSV
aws import assignments.csv

# Generate feedback for an assignment
aws mark --assignment "Essay 1" --student "john.doe@example.com"

# Export feedback
aws export --format pdf --output feedback/

Marking Assignments

Learn how to efficiently mark student work with AI assistance.

Single Assignment Marking

1. Open the assignment in the dashboard
2. Select the student submission to mark
3. Choose or create a rubric
4. Click "Generate Feedback" to get AI suggestions
5. Review and edit the feedback as needed
6. Assign final grade and save

Using Rubrics

Rubrics ensure consistent grading across all submissions:

# Create a rubric from template
aws rubric create --template essay --name "Analysis Essay"

# Load rubric for marking
aws mark --assignment "Essay 1" --rubric "Analysis Essay"

Keyboard Shortcuts

Batch Processing

Process multiple assignments simultaneously for maximum efficiency.

Basic Batch Operation

# Mark all ungraded submissions for an assignment
aws batch-mark --assignment "Lab Report 3" --rubric "lab-rubric"

# Process with custom worker count
aws batch-mark --assignment "Essay 2" --workers 4

# Review mode (don't publish)
aws batch-mark --assignment "Final" --review-only

Advanced Batch Configuration

# Configuration file: batch-config.yaml
assignment: "Midterm Essay"
rubric: "essay-rubric"
workers: 4
ai_model: "advanced"
review_threshold: 0.85  # Auto-publish if confidence > 85%
quality_checks:
  - consistency
  - tone
  - completeness

Monitoring Progress

Track batch processing in real-time:

• Dashboard shows live progress bar
• Estimated completion time updates dynamically
• Pause/resume capability for long batches
• Email notification on completion (optional)

LMS Integration

Connect with your Learning Management System for seamless workflow.

Supported Platforms

• Open University (OU)
• Moodle
• Canvas
• Blackboard Learn
• Google Classroom

Setup Example: Moodle

# Configure Moodle integration
aws config set lms.type moodle
aws config set lms.url https://moodle.university.edu
aws config set lms.token YOUR_API_TOKEN

# Test connection
aws lms test

# Import assignments
aws lms import --course "COMP101"

# Sync grades back to Moodle
aws lms sync --assignment "Quiz 1"

CLI Reference

Complete command-line interface documentation.

Global Options

aws [command] [options]

Global Options:
  --help, -h          Show help
  --version, -v       Show version
  --config FILE       Use custom config file
  --verbose           Enable verbose logging
  --quiet             Suppress non-error output

Commands

aws init

Initialize a new project or course.

aws init [NAME] [OPTIONS]

Options:
  --template TEMPLATE    Use project template
  --lms TYPE            Set up LMS integration
  --no-ai               Disable AI features

aws mark

Mark a single assignment or submission.

aws mark [OPTIONS]

Options:
  --assignment, -a ID   Assignment ID or name
  --student, -s EMAIL   Student email or ID
  --rubric, -r NAME     Rubric to use
  --no-ai               Skip AI feedback generation

aws batch-mark

Process multiple submissions in batch.

aws batch-mark [OPTIONS]

Options:
  --assignment, -a ID   Assignment to process
  --rubric, -r NAME     Rubric to use
  --workers, -w NUM     Number of parallel workers
  --review-only         Generate but don't publish

View complete API reference →

Frequently Asked Questions

Best Practices

Effective Rubric Design

• Use clear, measurable criteria
• Include 3-5 performance levels per criterion
• Provide specific examples for each level
• Weight criteria by importance
• Test rubrics on sample work before deployment

Optimizing AI Feedback

• Always review AI-generated feedback before publishing
• Provide examples of your feedback style to train the model
• Use the tone adjustment slider to match your teaching voice
• Enable "explanation mode" for constructive criticism
• Personalize at least one comment per submission

Workflow Efficiency

• Use keyboard shortcuts for common actions
• Process similar assignments in batches
• Create templates for recurring assignment types
• Schedule batch jobs during off-hours
• Use quality sampling for large batches

Data Security

• Enable encryption for local storage
• Use strong, unique passphrases
• Regularly backup your data
• Review audit logs periodically
• Use AI isolation mode for sensitive assignments

Getting Help