文字與正規表示式
用 Markdown 整理易讀的 README 步驟
使用工具
反覆被問用法,可能不是缺資訊,而是難找到。長背景和埋在段落裡的命令讓人不知何時能開始。對照原始碼與預覽,按讀者第一項實際任務重新排序。
讓標題成為路標
# Example Tool
A small example for checking a local text file.
## Before you start
Use a fictional input file.
## Try one example
Follow the steps below.
## If the result differs
Check the input and selected options.貼上後確認文件標題高於準備、範例、排錯各節。標題表達層級,不只是字級。按「先試一次」「結果不同」等任務命名,讀者無需從頭讀完也能定位。
標題過密會打斷閱讀。每節圍繞一個問題與必要步驟,先簡述前提,再透過範例結果深入解釋。預覽不評分寫作品質,需人工只讀標題檢查流程是否清楚。
分開輸入與預期輸出
## Input
```json
{"name":"demo","enabled":true}
```
## Expected output
```text
Validation succeeded.
```圍欄程式碼區塊把 JSON 與換行組織起來。Validation succeeded. 只是文件範例,不是預覽實際驗證結果。輸入輸出分開,避免讀者把結果行也複製成命令或資料。
程式碼前說明使用位置與需替換的值,使用虛構資料,勿混入正式憑證或位址。顯示成功不證明命令可執行,文件操作須另在專案安全環境驗證。
比較用表格,步驟用編號
| Option | Example | Meaning |
| --- | --- | --- |
| mode | preview | Inspect without applying |
| limit | 10 | Maximum displayed rows |多個設定按相同面向比較適合表格,順序操作適合編號步驟。不要把長流程塞入儲存格,以免窄螢幕反覆橫捲。
mode 與 limit 是虛構文件範例,不是實際工具選項。替換時核實真實設定,並區分範例值與預設值,讓讀者知道 10 是例子還是未設定時採用的值。
原始碼換行不一定是新段落
First line
Second line
Another paragraph前兩行原始碼屬於一段,空行後才是另一段。編輯器折行不同於語意分段,應每段一個主題,用空行分隔並對照預覽。
縮排或未關閉的程式碼圍欄會把後續標題吞入其他元素。後半全變程式碼時,應回看起始圍欄。先逐一調整邊界、縮排、空行,不要立即重寫整節。
預覽限制與發布行為不同
預覽不取得外部圖片、不執行原始 HTML,連結也不作為可跳轉導覽。圖片不顯示不能證明 URL 錯誤。HTML 輸出可含安全連結,但發布站點的連結檢查是另一項工作。
最終平台可能使用不同 Markdown 擴充、錨點、圖片規則與 CSS。這裡確認結構後還需檢查發布平台,不能保證完全相同樣式或相對連結存在,應區分已驗證與未驗證。
最後以新讀者視角找四個答案:準備什麼、輸入什麼、什麼結果算成功、失敗看哪裡。把散落答案圍繞任務集中,困惑分支處的短解釋可能比增加泛文更有用。