diff --git a/hiring.md b/hiring.md new file mode 100644 index 0000000..21fc9b4 --- /dev/null +++ b/hiring.md @@ -0,0 +1,53 @@ +# Hiring Cog + +The Hiring cog is a specialized ticket system designed to streamline the application and hiring process for staff members. It provides a professional, form-based interface for applicants and a persistent, public-facing application button for ongoing recruitment. + +--- + +## 1. Features + +- **Multi-Role Applications:** A single `/hire` command provides distinct application paths for different roles (Staff, PM, HPM). +- **Form-Based Submissions:** Uses Discord Modals (pop-up forms) with custom fields to ensure all necessary information is collected from applicants. +- **Automated Ticket Management:** Automatically creates private ticket channels for each applicant and sorts them into pre-configured categories. +- **Persistent Application Button:** The `/work` command creates a persistent "Apply" button in a public channel for ongoing PM recruitment. +- **DataManager Integration:** Logs the timestamp of completed applications, making it compatible with the `DataManager` cog for automatic data purging. +- **Hybrid Commands:** All administrative commands work with both slash commands (`/`) and your bot's prefix (`[p]`). + +--- + +## 2. User Workflow + +### For the `/hire` Command: + +1. An administrator runs the `/hire` command in a channel. +2. The bot posts an embed with three buttons: "Staff," "PM," and "HPM." +3. A user clicks the button corresponding to the role they are applying for. +4. The bot instantly creates a new private channel for that user in the appropriate category. +5. The bot presents the user with a pop-up form (Modal) containing the specific questions for that role. +6. The user fills out the form and submits it. +7. The bot posts the user's formatted application into their private ticket channel for staff to review. + +### For the `/work` Command: + +1. An administrator runs the `/work` command. +2. The bot posts a permanent message with an "Apply for PM Position" button to a designated public channel. +3. Any user can click this button at any time to begin the PM application process, which follows the same steps as the `/hire` workflow. + +--- + +## 3. Admin Commands + +### `/hiringset` + +The main command group for configuring the Hiring system. Requires `Manage Server` permissions. + +**Prefix Version:** `[p]hiringset` or `[p]hset` + +- `/hiringset staffcategory <#category>` + - Sets the category where new **Staff** application tickets will be created. +- `/hiringset pmcategory <#category>` + - Sets the category where new **PM** application tickets will be created. +- `/hiringset hpmcategory <#category>` + - Sets the category where new **HPM** application tickets will be created. +- `/hiringset workchannel <#channel>` + - Sets the public channel where the persistent "Apply" button from the `/work` command will be posted. \ No newline at end of file