documentationenhancementhelp wanted
Repository metrics
- Stars
- (45 stars)
- PR merge metrics
- (PR metrics pending)
Description
為了讓更多人(以及 AI 輔助)更容易參與文件貢獻,我們做了一輪基礎建設。借鏡開源社群把「編輯標準、自動品質檢查、AI 輔助協作」結合起來的精神,套用到 anoni.net/docs 的脈絡。這張票記錄已完成的部分,並徵求回饋與認領後續。
兩個原則
- 單一來源(SSOT):每份內容只有一個權威來源,其餘都是它的投影,避免多份各自漂移。
- 核心把關、周邊全開:翻譯、在地案例、來源回報、活動全面開放;Tor、Tails、OPSEC 等安全核心內容由維護者審核才合併。
已完成(都已 merged)
- 降低入門門檻(#84):新增 issue/PR 模板(中英並列)、
CODE_OF_CONDUCT、CODEOWNERS,README 補上「3 分鐘決策樹」;並把貢獻者百科補成完整的編輯標準單一來源。 - 編輯標準掃描器(#85、#86):
tools/docs_style_lint.py(純 Python 標準庫)接成 GitHub Action,在每個 PR 對變更的中文 Markdown 自動檢查標點、禁用句型、front matter。目前是 warn 階段(提醒不擋),只掃 zh-TW/zh-CN(英文標點規則不同)。 - 既有文章清理(#87、#88、#89):並列引號頓號、分號、破折號、口語、缺漏的 slug,zh-TW 與 zh-CN 全庫掃描 error 歸零。
- BECOME_ANONI 貢獻者 AI 載入協定(#91):一份公開協定,任何人把它貼進自己的 ChatGPT/Claude,就能照社群的編輯與安全標準協助產出、翻譯、校稿。正本在 repo 根目錄,文件頁 build 時嵌入,curl 可抓 raw 純文字。見 BECOME_ANONI。
幾個設計決定
- 掃描器只掃中文:英文本來就用破折號、分號,中文寫作規則不適用,所以排除 en。
- 規則文件本身、標點集合列舉這類「會引用被禁符號當例子」的內容,用 inline 指令或預設略過,避免誤判。
- 補舊文 slug 時沿用現有網址,不改動既有 URL。
後續(歡迎討論與認領)
- 掃描器由 warn 升為 blocking(收斂誤報後,合併前必過)。
- BECOME_ANONI 文件頁隨網站部署上線。
- AI 可讀的全文(
llms.txt/llms-full.txt),讓 AI 更容易正確引用本站內容。 - BECOME_ANONI 的英文版(英文需重新設計,非直接翻譯)與簡中版。
- 邀請更多夥伴實際走過這套貢獻流程,收集回饋再迭代。
第一次參與可看如何參與與認領主題。歡迎在這張票下回饋或認領。