---
title: 「建立一 Discord 公告機器人」企劃書
tags: proposal, project, template
description:
1. title 請改為 [專案名稱]企劃書
2. tag 請刪去template，加上專案內容類型或名稱
3. 下方會議記錄請使用會議記錄範本
4. 加上"{%hackmd BkVfcTxlQ %}"意為套用黑色模板
---
{%hackmd BkVfcTxlQ %}
# ***「建立一 Discord 公告機器人」企劃書***

:::info
> 專案負責人聯絡資訊：
> 許雅喬 / Email：[e-mail]

* 專案參與成員：
許雅喬、宋安琪、王筱鈞
共計 3 人
[name=企劃書撰寫：許雅喬]
:::

> [TOC]
>

***
## **專案資訊**
* 專案時期：
[time=] 2022/10/15 ~ 2022/11/19

* 專案客戶資訊：
> 條列該專案面對的客戶所有相關資訊
* 許鐊
* 公司：Project Abyss 深淵計畫
* 職稱：專案經理
* 主要聯絡方式：Email ( [e-mail])
> 平日上班時間因為個人原因會比較晚回信，因此若非必要則在非工作時間進行此次專案相關的討論

* 專案預期對象：
[name=] 「Project Abyss 深淵計畫」公司內部成員

* 專案交付：
* 軟體工具
* [Github Repository: Discord-Bot](https://github.com/Project-Abyss/Discord-Bot)
* 程式碼
* `README.md`
* 創建 Discord Bot Application 之操作手冊
* 書面文件
* [簡報](https://docs.google.com/presentation/d/1us4DTcOj83V2Qdx0Hy7sFCABxTsbTRweI7Zxmy5pF6U/edit?usp=sharing)
* 於交付當日進行簡報報告
* 企劃書
---
### *專案概述*
根據甲方所提供的七個公告範本，製作出一可套用特定模板並發送公告的 Discord 公告機器人。

主要使用 Python 的 discord.py 套件撰寫機器人的指令，包括：
* 呼叫模板選擇清單
* 規範模板格式
* 將使用者輸入的內容套用於模板
* 發布公告

---
### *預期目標*
專案目的為省去使用者在 Discord 發布公告時，需先複製模板再進行撰寫的麻煩，因此建立一 Discord 公告機器人提供使用。
使用者可自行選擇模板並依照機器人的提示輸入發布內容，而機器人則會將內容套進模板格式並公告於使用者選擇的頻道。

---
## **專案內容**
### *環境*
* Python == 3.10.4

### *技術簡介*
* 本專案提供使用者選擇範本進行內容的填寫，可選範本如下：

| 範本一 | 範本二 |
| ----- | ----- |
|  |  |
| 範本三 | 範本四 |
|  |  |
| 範本五 | 範本六 |
|  |  |
| 範本七 | |
|  | |
:::info
**說明**
* 範本基礎細節：
* <> 中的內容為使用者手動輸入
* 範本特殊功能：
* 範本二：可標註多個身分組
* 範本六：標題為使用者自行輸入
* 範本七：發布後機器人自行建立一討論串
:::
* 所撰寫的程式，將會完成以下功能：
1. 設定指令呼叫機器人進行操作
2. 利用下拉式選單提供使用者選擇模板
3. 以彈出視窗顯示表單，提示使用者輸入公告內容
4. 將輸入內容套入特定模板，進行排版並發布公告

### *系統架構*

#### Python script 說明
* `main.py`：撰寫抓取機器人 TOKEN，操作機器人之指令
* `.env`：存放機器人 TOKEN
* `cogs`：放置選擇模板之選單與所有模板之程式碼，包含功能、輸出設定
* `menu.py`：撰寫選擇模板之下拉式選單
* 以下 Python script 撰寫表單與輸出設定：
* `Meeting_Announcement_1.py` ➔ 範本一
* `Meeting_Announcement_2.py` ➔ 範本二
* `Announcement.py` ➔ 範本三
* `Foreign_courses.py` ➔ 範本四
* `Internal_courses.py` ➔ 範本五
* `Resource_storage.py` ➔ 範本六
* `Facebook_post.py` ➔ 範本五

### *系統流程*

---
## **專案安排**
### *專案工作*
* 專案經理（Project Manager, PM）
* 許雅喬
* 專案管理及規劃
* 與甲方溝通窗口
* 文件管理與撰寫
* 研發工程師（Research & Development, RD）
* 宋安琪
* 創建機器人與相關設定
* 範本特殊功能處理
* 操作手冊撰寫
* 王筱鈞
* 創建機器人與相關設定
* 範本基礎輸入與輸出排版處理
* 操作手冊撰寫

---
## **備註與附件**
* 專案 Github Repository
* [Github Repository: Discord-Bot](https://github.com/Project-Abyss/Discord-Bot)
* 專案成果報告 （簡報）
* [Discord 公告機器人 專案成果報告](https://docs.google.com/presentation/d/1us4DTcOj83V2Qdx0Hy7sFCABxTsbTRweI7Zxmy5pF6U/edit?usp=sharing)
### *會議紀錄*
* 與甲方的會議紀錄
* [Team B 啟動會議 會議記錄 (20221014)](https://hackmd.io/@4by55/BJ-HoBrQi)
* [「建立一 Discord 公告機器人」專案會議紀錄 (20221018)](https://hackmd.io/@4by55/r10OQFo7s)
* [「建立一 Discord 公告機器人」專案會議紀錄 (20221115)](https://hackmd.io/@4by55/r1u-TzG8j)