iT邦幫忙

2026 iThome 鐵人賽

DAY 18
0
Software Development

從零開始將作品整理成GitHub履歷系列 第 18 篇

Day18|README怎麼寫! Part 2

  • 分享至 

  • xImage
  •  

昨天我們一起整理了專案介紹、功能、開發環境及套件的README,今天就來完整的看看專案結構跟資料庫設計,然後寫README吧!

# 眼科病人與術前醫囑管理系統

## 專案介紹
## 主要功能
## 使用技術
## 開發環境

## 專案結構  
## 資料庫設計    
(今天寫這兩個ㄛ)


## 安裝與執行方式
## 專案畫面

專案結構

一開始AI叫我用 tree /F 來看現在的專案檔案,但她是本機的所有檔案而且出現了.vs、bin、obj 和 App_Data 的資料庫檔案,可是我之前已經將加入 .gitignore裡面了。
所以我用了 git ls-files 來查看Git目前追蹤的檔案,以這個結果為基礎再挑出重要的檔案整理寫進README裡面。

那麼這個就是我的專案結構

## 專案結構
eyes_prj/
├── App_Start/
├── Content/
├── Controllers/
│   └── HomeController.cs    
├── Database/
│   └── eyes_db.sql 
├── Models/
│   ├── Patients.cs  
│   ├── PreOpOrders.cs  
│   ├── PatientOrderViewModel.cs
│   └── eyesModel.edmx 
├── Scripts/ 
├── Views/
│   ├── Home/
│   └── Shared/
├── packages.config
├── Web.config
└── README.md

將專案結構寫進README

那之前就有做過整理專案不必要放進Git的檔案了,所以在整理結構時特別快就整理出來了,寫進README的內容我再加了一點備註在後面。

## 專案結構

eyes_prj/
├── App_Start/                    # ASP.NET MVC 應用程式設定
├── Content/                      # CSS 與 Bootstrap 樣式
├── Controllers/
│   └── HomeController.cs         # 處理系統主要功能與資料操作
├── Database/
│   └── eyes_db.sql               # 資料庫結構 SQL
├── Models/
│   ├── Patients.cs               # 病人資料模型
│   ├── PreOpOrders.cs            # 術前醫囑資料模型
│   ├── PatientOrderViewModel.cs  # 整合病人與醫囑資料
│   └── eyesModel.edmx            # Entity Framework資料模型
├── Scripts/                      # JavaScript、jQuery、Bootstrap
├── Views/
│   ├── Home/                     # 系統主要操作頁面
│   └── Shared/                   # 共用版面
├── packages.config               # NuGet 套件設定
├── Web.config                    # 應用程式與資料庫連線設定
└── README.md                     # 專案說明文件

資料庫設計

我這個專案在前面整理的時候就已經處理過這個部份了,當時將原本放在App_Data 裡面的 .mdf、.ldf 資料庫檔案排除,然後另外建立了Database/eyes_db.sql,讓之後下載專案的人可以透過SQL重新建立資料庫。
而這個專案的資料庫主要由Patients和PreOpOrders兩張資料表組成,Patients負責儲存病人的基本資料,PreOpOrders是負責術前醫囑,接著透過PatientId建立兩張資料表之間的關聯。

資料庫設計README

那除了上面講的資料庫設計和他們的關聯,我還大概列出了一些資料表主要的欄位,這樣可以更清楚的讓其他人知道資料表的功用。

## 資料庫設計
本專案主要包含兩張資料表:

### Patients
儲存病人的基本資料,主要包含:
- 病人姓名
- 病歷號
- 性別
- 出生日期
- 資料建立與更新時間

### PreOpOrders
儲存病人的術前醫囑資料,主要包含:
- 手術日期與手術名稱
- 過敏資訊
- 系統性疾病
- 用藥紀錄
- 眼藥醫囑
- 口服藥醫囑
- 術前檢查與其他備註


### 資料表關聯

`Patients.Id` ← `PreOpOrders.PatientId`
兩張資料表透過 `PatientId` 建立關聯,一位病人可對應多筆術前醫囑。

資料庫結構可透過以下 SQL 檔案建立:
`Database/eyes_db.sql`

今天先到這,明天一定可以寫完另外兩個的! 加油


上一篇
Day17|README怎麼寫! Part 1
下一篇
Day19|README怎麼寫! Part 3
系列文
從零開始將作品整理成GitHub履歷 共 22 篇
圖片
  熱門推薦
圖片
{{ item.channelVendor }} | {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言