技術選型
核心工具鏈
- Cursor編輯器：AI輔助寫作，智能補全和結構優化
- GitHub：版本控制、跨設備同步、團隊協作
- Markdown：輕量級格式，跨平臺兼容，與Git完美集成
`
與主流工具對比
選擇Cursor+GitHub適合：
- 技術背景開發者
- 重視數據安全和版本控制
- 主要處理技術文檔和代碼
- 需要深度自定義工作流
選擇語雀/Notion適合：
- 團隊協作需求強烈
- 非技術背景用戶
- 需要豐富多媒體內容
目錄結構設計
技術文檔庫/
├── 前端技術/
│ ├── 框架實踐/
│ └── 工具使用/
├── 后端開發/
│ ├── 語言特性/
│ └── 架構設計/
├── 數據庫/
│ ├── 關系型數據庫/
│ └── NoSQL/
└── README.md
設計原則：
- 按技術棧分類組織
- 便于檢索和擴展
核心構建流程
1. 項目初始化
mkdir 技術文檔庫 && cd 技術文檔庫
git init
# 創建目錄結構
mkdir -p "前端技術/框架實踐" "后端開發/語言特性" "數據庫/關系型數據庫"
2. 內容創作
- 使用Cursor的AI助手規劃文檔大綱
- 利用智能補全編寫技術內容
- Git管理版本變更
3. 版本管理
# 提交變更
git add .
git commit -m "feat: 新增技術文檔"
git push origin main
優勢與不足
主要優勢
- 專業版本控制：Git提供分支、合并、歷史追蹤
- AI智能輔助：Cursor提升內容創作效率
- 數據自主權：本地存儲，完全掌控數據
- 開發者友好：原生支持代碼高亮、技術圖表
- 成本可控：開源免費，無存儲限制
客觀不足
- 學習曲線較陡峭，需要Git和Markdown基礎
- 實時協作功能相對簡單
- 多媒體內容處理不如專業工具便捷
核心價值
這套方案特別適合技術人員構建個人知識體系：專業的版本管理 + AI輔助創作 + 完全的數據掌控權，在保證內容質量的同時，實現了高效的知識積累和管理。
選擇這個方案不是因為它最容易使用，而是因為它在技術文檔管理這個特定場景下，提供了最專業和可靠的解決方案。
cursor rules
description: 技術文檔庫主規則 - 個人技術知識管理倉庫的內容創作和AI協助規范
alwaysApply: true
技術文檔庫 Cursor Rules
🎯 項目定位
這是一個個人技術知識管理倉庫，專注于大模型、軟件開發等技術領域的深度文章和實踐總結。
📝 內容創作規范
文檔結構
- 使用提供的文章模板
.cursor/templates/article-template.md - 每篇文章必須包含front matter元數據
- 按照 “分類/子分類/文章.md” 的目錄結構組織
- 每個目錄都需要有README.md作為索引
寫作風格
- 使用中文撰寫技術文檔
- 采用通俗易懂的語言解釋復雜概念
- 重視實踐案例和代碼示例
- 提供清晰的步驟指導和最佳實踐
技術文檔要求
- 深入分析技術原理和底層機制
- 提供完整的代碼示例和運行結果
- 包含對比分析和架構圖表
- 注重技術的實際應用價值
- 保持內容的準確性和時效性
🔧 代碼規范
Markdown格式
- 使用標準Markdown語法，支持GitHub Flavored Markdown
- 代碼塊必須指定語言類型
- 使用適當的標題層級（H1為文章標題，H2-H6為章節）
- 表格格式要對齊，便于閱讀
- 鏈接使用有意義的描述文本
代碼示例
- 所有代碼示例必須可執行
- 包含必要的依賴和環境說明
- 提供預期的輸出結果
- 使用注釋解釋關鍵邏輯
- 遵循對應語言的最佳實踐
圖表和可視化
- 優先使用Mermaid繪制架構圖和流程圖
- 提供清晰的圖表說明
- 使用表格對比不同技術方案
- 圖片文件統一存放在對應文章目錄下
📊 內容管理
文件命名
- 使用有意義的中文文件名
- 避免使用日期作為文件名前綴
- 文件名要能體現文章核心內容
- 目錄名使用簡潔明確的術語
標簽系統
- 為每篇文章添加相關標簽
- 標簽要準確反映技術棧和主題
- 更新全局標簽云在根README中
- 標簽使用中文，便于檢索
版本控制
- 每次內容更新都要提交Git
- 提交信息格式: “更新: 文章標題 - 具體修改內容”
- 重要版本使用Git標簽標記
- 保持倉庫整潔，避免無意義的提交
🚀 AI助手行為準則
內容協助
- 優先使用中文回復和建議
- 理解技術文檔的深度要求
- 提供準確的技術信息和最佳實踐
- 協助改進文章結構和表達方式
- 建議相關的技術話題和擴展方向
代碼協助
- 生成可運行的完整代碼示例
- 提供詳細的技術解釋和注釋
- 建議更好的實現方案
- 協助debug和優化代碼
- 推薦相關的工具和庫
項目管理
- 協助維護文檔結構的組織性
- 建議新的分類和文章主題
- 幫助更新README和索引文件
- 協助Git操作和版本管理
- 提醒更新標簽和元數據
🎨 特殊要求
技術深度
- 不滿足于表面的使用說明
- 深入探討技術原理和設計思想
- 提供源碼分析和架構解析
- 關注性能優化和最佳實踐
- 結合實際項目經驗
實踐導向
- 每個概念都要有實際應用場景
- 提供端到端的完整解決方案
- 包含環境搭建到部署的全流程
- 預防常見問題和解決方案
- 分享踩坑經驗和教訓總結
持續改進
- 根據技術發展及時更新內容
- 收集和回應讀者反饋
- 完善文檔的可讀性和實用性
- 建立知識體系的內在聯系
- 保持學習和分享的熱情
@.cursor/templates/article-template.md
配置更新時間: 2025-05 | 適用于個人技術知識庫項目
