---
# System prepended metadata

title: Dungeon Master Overview and Documentation Goals
tags: [Dungeon Master]

---

---
tags: Dungeon Master
---

# Dungeon Master Overview and Documentation Goals

[Dungeon Master](https://dungeonmaster.raidguild.org/raids) is a toolkit for Moloch Hunters. This first version has launched as a DAO-first CRM tool based on, and customized for, the needs of [Raid Guild](https://www.raidguild.org/). Dungeon Master is *shared-gated* for authentication, with access being restricted to folks with Raid Guild DAO shares (the core Raid Guild DAO as well as the Seasons 0-3 Cohort DAOs). 

## General Overview

The initial goal for v1 was to move away from Airtable for managing Raid Guild *Moloch Hunting* processes. This included a focus on the following areas:
- Auth gated to Raid Guild DAO shares (including cohorts)
- Read/write access for anyone with share access
- Consultation and Raid status tracking
- Application and Member status tracking

These features are at the heart of v1, and the API design reflects these goals.

## Raid Lifecycle

As potential clients submit consultation requests through our *Hire Us* form, the information is sent to Dungeon Master as a *Consultation*. This includes core project information about the project.

Once a consultation has occurred and (if) the consultation is moving forward as a Raid, the *Cleric* is able to *promote* the Consultation to a Raid. This creates a *Raid* with the status of `awaiting`, and the Cleric is able to mark which roles are needed for the Raid.

After the Raid has been created and added to Dungeon Master, Raiders use Dungeon Master to track changes and post updates to ongoing Raids.


## Member Lifecycle

Dungeon Master is also used for tracking Raid Guild Applicants and promoting their status to Members. Once Members folks are able to be assigned to Raids.

## Cleric Training and Documentation

This is specifically for Raid Guild training, but these are useful goals to include in this overview outline. This is a reference to the goals included in the *Moloch Hunter RIP.*

### High-Level Documentation Goals

- Overview of the auth process (Raid Guild shares: Member or Cohorts 1-4)
- High-level documentation flow of the Raid lifecycle (a visual of Incoming -> Consultation -> Raid -> Raid Happening -> Raid Shipped )
    - Can generalize this more and include status breakdowns for things like *Preparing*
    - Call out each of the features in each stage (This is what happens during *Preparing*)
        - Add roles, add raiders, etc.
        - Organize the feature docs per stage (when used)
- Connecting wallet and navigating the UI with overviews of the following, making sure folks know the purpose of each route:
    - Raids (includes incoming Consultations)
    - Members (includes Applicants)
    - Profile
- Deeper Dives:
    - Raid and Raid Details:
        - Overview of the Raid list and sidebar for filtering
        - Navigate from Raid list to Raid Details, and open a Raid
            - Overview of the information found on the Raid Details
            - Showcase how to set *Roles needed* and assign Raiders
        - Overview of the *updates (comments* feed and how to add an update (and types of information we want to include as updates)
- Clerics:
    - Show how to "promote" a Raid from Consutation -> Raid (self-assigns you as the Cleric)
    - Show how to change a Raid's cleric from the Raid Details view
    - Dig into the Raid Details view and document how to assign Raid Members 

### Documentation Deliverables

As the documentation process unfolds we can see what mediums make the most sense. These are some potential approaches:
- Create 3 short videos describing the major workflows getting started with Dungeon Master:
    - Walking through the Consultation -> Raid -> Assigning lifecycle
    - Walking through the Raid Details and updating status/comments/Raid Party/etc.
- Gifs or short animations showing key features:
        - Update a status, add a comment, etc.
- Update the handbook to include necessary parts of Dungeon Master workflows
    - Auth and sharegating
    - Depending on how many pages there are, this could become it's own sidebar section in the Handbook but this structure can evolve as the docs progress

### Resources

- Reach out to JP and Scott for any Dungeon Master specific questions as they come up during this RIP

### Documentation Logistics

- The Dungeon Master documentation initiative is funded by the *Moloch Hunters* RIP
    - Govinda, HHH, Christina are collaborating on the other documentation pieces of the Moloch Hunter RIP
- Clerics are using this for Raids, but maybe not being used in the Roundup (although this may be fine if folks are using it the meetings)