← Back to Resources

README authoring guides

SCORP Roleplay Authoring Documents

For Authors: Which Document Do I Use?

Welcome! Here are the three authoring documents and what they're for:

---

1. How to Author a Roleplay ← START HERE

📄 File: `how-to-author-a-roleplay.md`

For: First-time authors who want a guided walkthrough Length: 10-15 minute read What it covers:

- Step-by-step instructions (5 easy steps) - Writing tips and examples - Common scenarios you can copy/paste - Troubleshooting Q&A

Start here if: You're new to SCORP or educational roleplays and want someone to walk you through the process.

---

2. SCORP Roleplay Authoring Guide for Educators ← THE TEMPLATE

📄 File: `roleplay-authoring-guide-for-authors.md`

For: Authors who want detailed explanations of every field Length: 30-minute read + 60 minutes of writing What it covers:

- Every section of the template explained in plain English - What each field means and why it matters - All 21 available activity types and how to use them - Quick checklist of what you need to write

Use this as: Your authoring template. Follow the structure, fill in your content, and submit it.

---

3. SCORP Human-First Roleplay Authoring Template (HF v1) ← TECHNICAL REFERENCE

📄 File: `roleplay-authoring-template-hf-v1.md`

For: Developers, curriculum specialists, and people integrating with systems Length: Brief reference format What it covers:

- Exact field names and syntax - Conversion rules and technical specifications - Schema requirements

Use this for: Reference only. Most authors should use Document #2 instead.

---

Recommended Path for First-Time Authors

``` 1. Read "How to Author a Roleplay" (15 min) ↓ 2. Open "SCORP Authoring Guide for Educators" (your template) ↓ 3. Write your roleplay (60-90 min) ↓ 4. Submit to SCORP team ```

---

Recommended Path for Experienced Authors

``` 1. Use "SCORP Authoring Guide for Educators" directly ↓ 2. Refer to activity types (Part 10) as needed ↓ 3. Submit ```

---

Files in This Set

| File | Purpose | Audience | |------|---------|----------| | `how-to-author-a-roleplay.md` | Step-by-step guide | Educators (first time) | | `roleplay-authoring-guide-for-authors.md` | Complete template + explanations | Educators (all) | | `roleplay-authoring-template-hf-v1.md` | Technical specification | Developers | | `roleplay-authoring-to-yaml-mapping-v1.md` | Conversion rules | Developers | | `roleplay-yaml-template-v1.yaml` | Intermediate YAML format | Developers |

---

What Happens After You Submit

1. Conversion (2-3 days) We automatically convert your template into the technical format the platform needs.

2. Testing (1 week) You test your roleplay with a small group of students.

3. Refinement (1-2 days) We make adjustments based on your feedback.

4. Publication (same day) Your roleplay is live and available for other educators to use.

---

Getting Help

Questions about the template?

→ Check "How to Author a Roleplay" section "Troubleshooting"

Need an example?

→ See "SCORP Authoring Guide" section "Scenario 1, 2, or 3"

Not sure which activity type to use?

→ See "SCORP Authoring Guide" section "Part 10: Available Activity Types"

Technical or integration questions?

→ See "SCORP Human-First Roleplay Authoring Template (HF v1)"

Still stuck?

→ Email us at [email@scsw.org]

---

Video Tutorials

Short videos demonstrating how to use these guides:

- [Coming soon] How to Write a Roleplay (15 min) Walkthrough of the 5 steps, with a real example

- [Coming soon] Roleplay Design Patterns (10 min) Three common scenarios (debate, negotiation, multi-round game)

- [Coming soon] Activity Types Deep Dive (15 min) When and how to use Chat, Decision, Inject, etc.

- [Coming soon] Running Your First Simulation (20 min) Tips for instructors facilitating the roleplay

---

Additional Resources

SCORP Platform:

- Main website: [scsw.org](https://scsw.org) - Library of published roleplays: [scsw.org/library](https://scsw.org/library) - Documentation: [scsw.org/docs](https://scsw.org/docs)

Support:

- Email: [support@scsw.org](mailto:support@scsw.org) - Office hours: Tuesdays 2-4 PM EST (virtual) - FAQ: [scsw.org/faq](https://scsw.org/faq)

---

License & Attribution

These guides are free and open for educators to use and adapt.

Attribution: If you create a roleplay using these guides, please credit:

> Created with the SCORP Roleplay Authoring System (Seachange Simulations Project)

Share your creations: We'd love to feature your roleplay in the public library! Email us or submit through the SCSW website.

---

Version History

| Version | Date | Changes | |---------|------|---------| | 1.0 | Aug 2026 | Initial release for educators | | 0.9 | Jul 2026 | Beta testing with pilot group |

---

Quick Reference: Activity Types

By learning goal:

- Discussion/debate: Chat, AskTheMediator, Brainstorm - Decision-making: Decision, Vote - Information gathering: ShowDocument, Introduction, Cast - Reflection: DebriefQuestions, NeedsAndFears - Surprise/events: Inject, Announcement

By phase:

- Opening: Introduction, Cast, ShowDocument, Schedule - Main activity: Chat, Decision, PrivateChat, Brainstorm - Closing: DebriefQuestions, Announcement

By audience:

- Students: Chat, Decision, ShowDocument, Cast, etc. (most types) - Facilitator only: Control, EditDocument, LastLogins - Both: Introduction, Schedule, Announcements

---

Checklist: Before You Submit

- [ ] All required sections filled in - [ ] Roleplay name and blurb are clear - [ ] At least 3 student roles defined with distinct interests - [ ] 2-4 phases with clear progression - [ ] Learning objectives stated (2-3 goals) - [ ] Activities planned for each phase - [ ] Character descriptions include both public and private info - [ ] Debrief questions written - [ ] Any images/documents named and ready to upload - [ ] You've proofread for typos and clarity

---

Ready to Start?

👉 [Open the SCORP Authoring Guide](roleplay-authoring-guide-for-authors.md)

or

👉 [Watch the tutorial video] (coming soon)

---

Questions? We're here to help!

Email: [support@scsw.org](mailto:support@scsw.org) Office hours: Tuesdays & Thursdays 2-4 PM EST Slack community: [Join our educator community](https://slack.scsw.org)

---

Version 1.0 | August 2026 | SCORP Roleplay Authoring System