Table of Contents

頁面格式

簡介
規則

1. 頁面結構
2. 一頁一個主題
3. 程式碼
4. 簡化技術中文（參考 STE100）
5. 繁體中文與圖表

範本

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

頁面格式

附錄 · 來源：本書編輯規則

簡介

本頁定義每個頁面的固定格式。/jsc-wiki:book-search 與 /jsc-wiki:book-import 都依本頁建立與修改頁面。

規則

1. 頁面結構

每頁依下列順序排列：

順序	內容	必要
1	`# 標題`	是
2	來源列：`> 第N章領域 · 來源：…`	是
3	`## 簡介`：一到兩句，說明這頁的用途	是
4	`## 步驟`：`### 1.`、`### 2.` 依序編號	是
5	補充段落：常見問題、範例設定檔、參考來源	否
6	頁尾導覽（由工具自動產生）	自動

非步驟型頁面可用 ## 參考連結 或 ## 提示詞 取代 ## 步驟。

2. 一頁一個主題

一頁只寫一個主題。主題已存在時，修改原頁面，不新增重複頁面。
只寫來源有說明的內容。不要補充來源沒有的事實。
網路來源要在頁尾的 ## 參考來源 列出連結。用自己的話改寫，不要整段複製。
密碼、token 和金鑰一律用占位符，例如 <密碼>、<Runner token>。

3. 程式碼

每個程式碼區塊標示語言，例如 bash、powershell、json。
一個區塊只放一個動作。需要說明時，把說明放在區塊前面。

4. 簡化技術中文（參考 STE100）

這條規則參考 ASD-STE100 skill 的結構規則，改成適用於繁體中文。目的是讓讀者與 AI 都不會誤讀。

規則	正確	避免
一句一個動作	「開啟檔案。讀取第 3 行。」	「開啟檔案並讀取第 3 行，然後確認是否相符。」
句子長度	步驟句 30 字以內，說明句 40 字以內	多個子句串成長句
步驟用祈使句	「安裝 Redis。」	「Redis 需要被安裝。」
主動語態	「服務會讀取設定檔。」	「設定檔會被服務讀取。」
不用分號	拆成兩個句子	「；」
一詞一義	同一個動作整頁只用一個詞（例如一律用「安裝」）	同一個動作交替用「安裝」「部署」「裝設」
名詞堆疊不超過 3 個	「資料庫連線設定」	「高可用資料庫叢集連線逾時設定」
不省略主詞和受詞	「重新啟動服務。」	「重啟。」
不用行銷用語	寫出數字或事實	強大、無縫、輕鬆、完美
保留語氣強度	「可能失敗」維持「可能」	把「可能」改成肯定句
段落	一段一個主題，最多 6 句	一段混合多個主題
序列用清單	三個以上的步驟或條件用編號清單	把步驟藏在一個長句裡

簡化只改文字形式，不可以刪除警告、條件、版本號和數值。

5. 繁體中文與圖表

繁體中文且無亂碼

檔案一律使用 UTF-8（無 BOM、LF 換行）。
全文使用繁體中文與台灣慣用詞，例如「軟體」「檔案」「伺服器」。
中文句子使用全形標點（，。：？！）。程式碼、網址與路徑使用半形。
英文與數字前後不強制加空格，但全頁要一致。
存檔後執行 book.py lint。工具會檢查 U+FFFD 與常見亂碼字元。

盡量用圖表

內容類型	使用
流程、判斷、步驟順序	Mermaid `flowchart`
元件之間的互動	Mermaid `sequenceDiagram`
架構與關係	Mermaid `flowchart` 或 `graph`
參數、連接埠、版本、比較	表格
目錄結構	縮排清單或程式碼區塊

範例：本頁的建立流程。

flowchart LR
    A[網路蒐集] --> B[整理成草稿]
    B --> C{主題已存在?}
    C -- 是 --> D[修改原頁面]
    C -- 否 --> E[新增頁面]
    D --> F[檢查格式]
    E --> F
    F --> G[更新目錄與導覽]
    G --> H[推送到 wiki]

每頁至少放一張圖或一個表格。內容確實不適合時可以省略。圖要放在說明文字之後，並用一句話說明圖在表達什麼。

範本

# Redis

> 第5章 資料庫與搜尋 · 來源：Ubuntu 知識庫

## 簡介

Redis 是記憶體式鍵值資料庫。本頁說明在 Ubuntu 安裝 Redis 的步驟。

## 步驟

### 1. 安裝相依套件

```bash
apt update && apt install -y lsb-release curl gpg
```

### 2. 啟動服務

```bash
systemctl enable --now redis-server
```

## 參考來源

- [Redis 官方文件](https://redis.io/docs/)