iT邦幫忙

2026 iThome 鐵人賽

DAY 17
0
Software Development

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

Day17|README怎麼寫! Part 1

  • 分享至 

  • xImage
  •  

昨天我建立了第一份README.md,也大概列好了README的基本骨架,所以今天就是要來填寫我的內容。

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

## 專案介紹
## 主要功能
## 使用技術
## 開發環境
## 專案結構
## 資料庫設計
## 安裝與執行方式
## 專案畫面

專案介紹

首先我來介紹一下我這半個月在整理的專案是什麼,這個專案是我跟我同學一起做的期末專案,是一個「眼科病人與術前醫囑管理系統」。
目標是要將普通的紙本術前醫囑單做成一個可以以管理病人資料及填寫、查看、修改醫囑的系統,那我們還新增了列印功能,可以把在系統上填寫的醫囑轉回紙本醫囑單的版面,並支援列印。

把專案介紹寫進README

因為README不像是期末報告要說的那麼詳細,他需要的重點是:

「專案用途、解決的問題、主要能做什麼」

所以這個才是我要放進去的內容:

## 專案介紹

本專案為一套眼科病人與術前醫囑管理系統,
將原本紙本的術前醫囑單轉為電子化管理。

系統可以管理病人基本資料與術前醫囑,
提供資料的增刪查改功能。
完成的術前醫囑也可以轉為接近原始紙本醫囑單的版面並進行列印,
讓病人資料與術前醫囑可以更方便地保存與管理。

主要功能

這個專案的主要功能就是病人的基本資料及術前醫囑管理。可以對這些資料新增、修改、刪除,依病人姓名或病歷號搜尋資料,將在系統上填寫的術前醫囑轉為紙本醫囑單的版面並提供列印。

主要功能的README

## 主要功能

- 病人基本資料管理
- 術前醫囑管理
- 依病人姓名或病歷號搜尋資料
- 新增病人與術前醫囑資料
- 查看術前醫囑詳細內容
- 修改既有資料
- 刪除病人與醫囑資料
- 將術前醫囑轉為接近紙本醫囑單的版面
- 支援術前醫囑列印

使用技術

這個專案採用ASP.NET MVC + Entity Framework Database First + SQL Server LocalDB。
雖然前面在整理專案環境的時候已經確認過一次了,但為了確保README裡面的資訊不能寫錯,所以我還是重新從專案檔案確認了一次。
從 eyes_prj.csproj可以看到這個專案使用 .NET Framework 4.7.2,也可以找到Entity Framework 6.2.0 和ASP.NET MVC 5.2.9。
再查看packages.config,可以看到專案安裝的NuGet套件,包含了 Bootstrap 5.2.3、jQuery 3.7.0、Razor 3.2.9、Modernizr 2.8.3 等。
https://ithelp.ithome.com.tw/upload/images/20261001/20178158kFdUmBvZ5O.png
但是README不需要把所有安裝的套件都列出來,所以只挑出幾個主要的技術放進README就好了。

使用技術的README

## 使用技術

- C#
- ASP.NET MVC 5.2.9
- Entity Framework 6.2.0(Database First)
- SQL Server
- Bootstrap 5.2.3
- jQuery 3.7.0

開發環境

那麼這個專案我們是在 Visual Studio 上面進行開發的,資料庫的部分是使用SQL Server LocalDB作為本機資料庫環境,.NET Framework 4.7.2 是這個專案的目標執行框架。

開發環境的README

整理完寫進README就是:

## 開發環境

- Visual Studio
- .NET Framework 4.7.2
- SQL Server LocalDB

好的那今天寫了專案介紹、主要功能、使用技術、開發環境,完成README的前半部分了! 我也更了解要怎麼把原本介紹專案時的一大串文字抓出重點,再整理成簡單容易理解的README,那麼明天繼續寫剩下的README吧


上一篇
Day16|README.md骨架
系列文
從零開始將作品整理成GitHub履歷 共 17 篇
圖片
  熱門推薦
圖片
{{ item.channelVendor }} | {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言