AGENTS.md Generator

1

Project Basics

做乜用: 等 AI 一睇就知你盤生意/呢個 App 係做乜、俾邊個用。想像你請緊一個新同事返工,佢第一日要知嘅嘢。

Project name 一句話描述(做乜 / 俾邊個用) 網址 / 環境上載 Project Workflow(項目流程文件,如有)

未上載檔案。純文字檔(.txt/.md)會直接將內容寫入 AGENTS.md;其他格式(PDF/Word)只會記低檔名,建議你另外將重點貼喺呢個欄:

上載 Functional Spec(功能需求文件,如有)

未上載檔案。純文字檔(.txt/.md)會直接將內容寫入 AGENTS.md;其他格式(PDF/Word)只會記低檔名,建議你另外將重點貼喺呢個欄:

2

Tech Stack

技術性 part

做乜用: 話俾 AI 知用緊邊套工具起呢個網站/App。呢 part 好似問「間廚房用邊隻牌子嘅爐頭」— 通常係負責開發嘅人先答到,你唔識好正常。

我唔識,交俾 AI / 開發人員自己決定就得

Frontend

Backend

Package manager / tooling

3

Folder Structure

技術性 part

做乜用: 個project啲file點樣擺放,好似公司檔案夾點分類噉。純粹方便開發,對生意運作冇直接影響,唔識就跳過得㗎。

我唔識,交俾 AI 用番業界慣例就得

4

Coding Standards

技術性 part

做乜用: code 要點寫,好似公司內部嘅「文件格式指引」。如果你冇特別要求(通常都冇),交俾 AI 跟業界標準就得。

我唔識,跟業界標準就得

固定規矩(一定會寫入 AGENTS.md,唔使揀): 所有 code — 無論係你自己寫定係 AI 生成 — 每個功能/每段邏輯都要同時有英文同 繁體中文 雙語註解解釋緊做緊乜。

Naming / style conventions Skills / 想用邊啲工具上載 Coding Standard / Skill 文件(如公司已有文件格式指引,可以直接上載)

未上載檔案。純文字檔(.txt/.md)會直接將內容寫入 AGENTS.md;其他格式(PDF/Word)只會記低檔名並包含喺 zip 打包內,建議你另外將重點貼喺下面欄位:

5

User Management / Auth

生意決定,你答得到

做乜用: 你啲客人/員工點樣登入你個系統,同埋邊種人可以睇到/做到邊啲嘢。呢個唔係技術問題,而係生意決定 — 好似間舖頭邊個有鎖匙、邊個可以埋數。呢part好緊要,建議都填。

客人/員工點樣登入有幾多層用戶(揀一個最貼近嘅)

1層:人人平等 2層:管理員+用戶 3層或以上未決定

邊種人有邊種權限(詳細講,好似列出「邊個有邊條鎖匙」)

6

API Conventions

技術性 part

做乜用: 唔同系統/程式之間點樣交換資料嘅規矩,好似部門之間點樣交table做嘢。呢part好技術性,一般生意人唔需要理解,建議直接剔「交俾 AI」。

我唔識,交俾 AI 用業界標準就得

7

密碼 / 敏感資料保管

好緊要,建議填

做乜用: 你啲密碼、信用卡資料、客戶私隱呢啲嘢點樣保管,唔可以俾人喺網上見到或者poup㗎入code度。呢個關係到你間公司嘅法律責任,強烈建議填,唔識點寫可以直接用範例。

要求

8

Git Workflow

技術性 part

做乜用: 團隊點樣一齊改同儲存 code、邊個改咗乜嘢要點記錄。如果得你自己一個人 / 淨係用 AI 幫手做,呢part通常唔重要,可以剔「交俾 AI」。

我唔識 / 唔需要,交俾 AI 決定就得

9

Testing & QA + Development Workflow

技術性 part

做乜用: 改完個網站/App 之後,點樣確保冇整壞其他嘢先至比人用,同埋團隊(或AI自己)由「開始改一個功能」到「改完出街」跟嘅步驟。呢兩樣嘢好多時一齊講先講得通,所以合埋一part。

我唔識,AI gen(交俾 AI 用番穩陣做法就得)

你有幾多個環境(Environment)?

Production(正式環境)— 必須 Testing(測試環境) Development(開發環境)

預設淨係有 Production。剔埋 Testing / Development 之後,AGENTS.md 會加入規矩:所有開發喺 Development 環境進行,寫一個功能鍵/按鈕將成個程式複製去 Testing 環境測試,測試冇問題先撳按鈕複製去 Production。

10

Setup / Run Commands

技術性 part

做乜用: 開發人員/AI點樣喺自己部電腦度開啟、測試呢個project嘅指令(例如「點樣裝好啲工具」「點樣打開睇下有冇整壞」)。純技術操作,一般生意人唔需要理解。

我唔識,交俾 AI 自己搞掂/自己記低就得

11

Deployment(部署喺邊度)

部分你答得到

做乜用: 你個網站/App最終擺喺邊個平台俾人睇到 — 好似問「間舖開喺邊條街」。如果你有用緊嘅平台(例如 Wix、Shopify、或者外判開發公司已經幫你搞咗)可以填,唔知道就交俾 AI。

我唔識 / 未決定,交俾 AI 或者開發人員建議就得

網站部署喺邊(如知道) 資料庫/後台放喺邊(如知道) 其他部署備註 FTP 資料(如果要俾 AI 直接上載檔案)

⚠️ 警告: 呢啲 FTP 登入資料會直接寫入 AGENTS.md,方便 AI 上載檔案。項目完成之後,一定要更改呢組 FTP 密碼(同建議更改用戶名),唔可以將呢份文件一直保留住原本嘅正式登入資料,以免留低安全漏洞。

12

Guardrails — AI 絕對唔可以做嘅嘢

最重要,一定要填

做乜用: 好似同新同事講「呢啲嘢千祈唔好做,做錯咗可以搞出大鑊」。呢part係最實際保護你盤生意嘅地方,建議全部剔晒,再加返你自己諗到嘅。

唔改現有客戶數據唔亂刪檔唔亂加收費服務改收費功能要先講唔留客戶資料喺code 唔推翻已定決定

其他自訂規矩

13

未來發展計劃

生意決定,你答得到

做乜用: 而家起緊網站/App嘅時候,如果早知你將來想點發展,AI可以幫你揀啲「將來易加、唔使推倒重來」嘅做法。好似裝修屋企時,如果知將來想加房,一開始就會預留位同喉管。

將來會唔會出 Mobile App?

唔需要將來可能會已經計劃緊

需唔需要 Multi-Language(多過一種語言)?

只需要一種將來先加而家已經需要

邊幾種語言?(可揀多過一個) 其他語言(用逗號分開) 其他將來想加嘅功能(有都得,冇都得)

14

Design / 視覺風格

生意決定,你答得到

做乜用: 個網站/App想睇落係咩感覺 — 好似揀舖頭裝修風格。呢part你一定答得到,因為呢個係品味/品牌問題,唔係技術問題。

想要邊種風格?(可揀多過一個) 主色調(如果有品牌顏色) 參考例子(有冇鍾意風格嘅網站/App想我哋參考?) 已有品牌指引 / Logo?

未上載檔案(如有 Logo/品牌指引檔案可上載,方便 AI 參考)。

或者提供連結(e.g. Google Drive / Figma / 品牌網站)

15

其他備註

做乜用: 任何未有提及、但你想 AI 知道嘅嘢,例如點聯絡返你、平時用邊個平台傾偈等等。