指南 · 文件

開發者文件怎麼寫,AI 才讀得懂、引得到?

更新於 2026-11-06 · kagentx

簡答

一頁只回答一個問題:標題就是問題,第一段是答案,寫清適用版本和更新日期,程式碼範例是能複製的文字,正文直接寫在 HTML 裡。llms.txt 可以做:我們 2026-11-06 抽樣了 11 個知名文件站的 /llms.txt,8 個有(如 Stripe、Cloudflare、Vercel、Next.js、React),3 個沒有(MDN、OpenAI 平台、Python 文件)。這些檔案被誰讀,官方沒有說明,我們未核實;它對 AI 搜尋推薦有沒有用,目前沒有證據。

知名開發者文件站都有 llms.txt 嗎?

不都有,但多數有。我們在 2026-11-06 用 curl 打開了 11 個知名文件站根路徑下的 /llms.txt:8 個回傳 200,3 個回傳 404。這只是一次抽樣,不代表所有文件站,也不說明有 llms.txt 的站從中得到了什麼。

文件站/llms.txt(2026-11-06)我們看到的
docs.stripe.com有(200)約 97 KB;開頭是寫給 AI 程式工具的提示,不是普通簡介;每頁另有 .md 版本(/payments.md 回傳 text/markdown);沒有 llms-full.txt(404)
developers.cloudflare.com有(200)約 17 KB,按產品分組,每個產品連結到自己的 llms.txt;llms-full.txt 存在,約 70 MB
docs.anthropic.com有(轉址到 platform.claude.com)約 98 KB
vercel.com/docs有(308 轉址到 vercel.com/llms.txt)約 5 KB;vercel.com/docs/llms-full.txt 存在,約 12 MB
supabase.com有(200)約 3 KB
nextjs.org有(200)約 15 KB;有「什麼時候該用這個網站」一節,寫明哪些問題以文件為準
react.dev有(200)約 15 KB;開頭的連結指向頁面的 .md 版本
docs.github.com有(200)約 29 KB;有「怎麼用」一節,指向取全文和搜尋的介面
developer.mozilla.org沒有(404)—
platform.openai.com沒有(404)—
docs.python.org沒有(404)—

從這批檔案能看到三種做法:一份簡短的目錄(Supabase、React);按產品拆成多份、再用一份總目錄串起來(Cloudflare);目錄加每頁的 Markdown 版本(Stripe、React)。有 llms-full.txt 的兩家,檔案分別有幾十 MB 和十幾 MB,一次讀不完,這是我們的推斷,不是它們說的原因。

這些檔案被誰讀、讀了多少,我們沒有找到官方說明,未核實。它對 ChatGPT、Perplexity、Google 這類 AI 搜尋的推薦有沒有用,見 llms.txt 是什麼?有用嗎?:目前沒有證據。

文件站和一般行銷頁,對 AI 來說有什麼不同?

文件的讀者更多是在問「怎麼做 X」「這個錯誤是什麼意思」,而不是「哪個產品好」。所以文件頁要能直接當答案被摘走,而不是靠別的頁面補全上下文。

做法為什麼
一頁只回答一個問題,標題就是問題標題和問句一致,AI 和搜尋都容易對上
第一段直接給答案,再展開摘走第一段就是完整的答案
每頁寫清適用的版本和最後更新日期舊版本的做法最容易被當成現在的做法,見內容更新指南
程式碼範例能直接複製,寫清語言、前提和預期輸出不要用截圖,不要把指令和輸出混在一起
錯誤訊息原文寫進頁面,旁邊寫原因和修法使用者會把錯誤原文拿去搜和問
頁面之間用普通連結,連結文字說清目標頁是什麼不要只寫「點這裡」「見下文」
正文直接寫在 HTML 裡不要靠瀏覽器端腳本渲染,見 JavaScript 指南

正文的寫法見 怎麼寫出 AI 願意引用的內容?改寫前後對照;頁面更新和日期見 頁面寫上更新日期,對 AI 引用有用嗎?;爬蟲會不會執行腳本見 AI 爬蟲會執行 JavaScript 嗎?。

一個文件頁具體可以怎麼寫?

下面是一個骨架(產品和介面是虛構的):標題是問題,第一段是答案,寫了適用版本和日期,各語言的程式碼分小節,錯誤用表格。

# How do I verify a webhook signature?

Verify the X-Example-Signature header with your endpoint secret before
you read the body. Use the official library; do not compare strings yourself.

Applies to: API version 2026-10-01 and later. Last updated: 2026-11-06.

## Node.js

    const event = example.webhooks.verify(rawBody, signature, secret);

## Python

    event = example.webhooks.verify(raw_body, signature, secret)

## If verification fails

| Error | Cause | Fix |
|---|---|---|
| invalid_signature | Body was parsed before verifying | Pass the raw body |
| timestamp_too_old | Server clock is off by more than 5 minutes | Sync the clock |

Related: [Webhook events](/docs/webhooks/events/), [Retries](/docs/webhooks/retries/)

llms.txt 和 llms-full.txt 要做嗎?

開發者文件可以做,代價小,但別指望它帶來推薦。llms.txt 是目錄,llms-full.txt 是把文件拼成一個大檔案;規範和現狀見 llms.txt 是什麼?有用嗎?。從上面的抽樣看,做的站裡有的還給每個頁面提供了 .md 版本,讓工具直接取到乾淨的文字。第一版可以用 llms.txt 產生器 起草,再手改。

如果文件很大,不要只做一個 llms-full.txt:按產品或章節拆成幾份,每份在目錄裡寫一句說明,抽樣裡 Cloudflare 就是這樣做的;這樣每份更小,我們推斷更容易被讀完。

怎麼一步一步改?

  1. 1. 先確認爬蟲進得了文件站

    文件站常放在子網域,要單獨看它的 robots.txt 和防火牆。規則見 AI 爬蟲的 robots.txt 怎麼寫?。

  2. 2. 挑 20 個最常被問到的頁面,先改這些

    用你的搜尋日誌、客服問題和 GitHub issue 選,不要一次全改。

  3. 3. 每頁改成「標題是問題、第一段是答案」

    加上適用版本和最後更新日期。

  4. 4. 程式碼範例換成可複製的文字

    寫清語言、前提、預期輸出;錯誤原文進表格。

  5. 5. 加結構化資料,並和正文一致

    文件頁可以用 TechArticle 或 Article,標題和日期要和頁面上看到的一樣,見 結構化資料對 AI 搜尋有用嗎?。

  6. 6. 發布 llms.txt,需要時再加 .md 版本和 llms-full.txt

    先發目錄,每條連結寫一句話說明;文件大就按產品拆開。

  7. 7. 每次發版改日期,並看伺服器日誌

    在日誌裡搜 /llms.txt 和 .md 的請求,看是哪些 User-Agent 來的,有紀錄再繼續投入。

常見問題

開發者文件需要 llms.txt 嗎?

可以做,成本低;但沒有證據表明它會讓 AI 搜尋更多推薦你。2026-11-06 我們抽樣 11 個知名文件站,8 個有、3 個沒有(MDN、OpenAI 平台、Python 文件)。

llms-full.txt 要不要做?

不是必須。抽樣裡 Cloudflare(約 70 MB)和 Vercel(約 12 MB)有,Stripe 沒有(404)。文件很大時更實際的做法是按產品拆成多份。

每個文件頁要不要提供 Markdown 版本?

Stripe 和 React 這樣做了(在網址後加 .md,2026-11-06 實測回傳 200)。是否值得做取決於你的讀者是否常用 AI 程式工具,我們沒有資料說明它對搜尋引用的影響。

文件放在子網域還是子目錄?

我們沒有找到官方說明哪種更好,未核實。抽樣裡兩種都有(docs.stripe.com 是子網域,vercel.com/docs 是子目錄)。無論哪種,都要單獨確認 robots.txt 和防火牆。

程式碼範例應該放截圖嗎?

不要。截圖裡的文字讀不到,也不能複製;用文字程式碼區塊,並寫清語言和前提。

出處

kagentx

你的頁面,爬蟲讀得到嗎?
讓評測告訴你

評測檢查爬蟲能不能進、正文是否直出,再把買家的問題拿去問 ChatGPT、Perplexity、Claude(開連網搜尋),看有沒有提到你。基礎版 $1,一般 2–3 分鐘出結果。