From 8ae20da0a2ecf085b817dc6e32de74571365a3f7 Mon Sep 17 00:00:00 2001 From: tukuaiai Date: Tue, 16 Dec 2025 21:07:46 +0800 Subject: [PATCH] =?UTF-8?q?refactor(docs):=20=E5=B0=86=20AI=20=E6=8C=87?= =?UTF-8?q?=E4=BB=A4=E5=90=88=E5=B9=B6=E5=88=B0=20AGENTS.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 删除了独立的 CLAUDE.md 和 GEMINI.md 文件，并将其内容移动到 AGENTS.md 中，以集中管理面向 AI Agent 的文档。同时清理了 system_prompts 目录下一个多余的元文件。 --- AGENTS.md | 156 +++++++++++++++++- CLAUDE.md | 53 ------ GEMINI.md | 95 ----------- .../已经转移到 prompts 的文件夹中.md | 1 - 4 files changed, 155 insertions(+), 150 deletions(-) delete mode 100644 CLAUDE.md delete mode 100644 GEMINI.md delete mode 100644 system_prompts/已经转移到 prompts 的文件夹中.md diff --git a/AGENTS.md b/AGENTS.md index 9d2bed4..8a955a6 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -35,4 +35,158 @@ ## Architecture Overview & Workflow - 工作流倡导「规划 → 上下文固定 → 分步实现 → 自测 → 复盘」，对应资产分别存放在 `documents/`、`prompts/`、`libs/` 与备份脚本中。保持单向数据流和清晰责任边界可以避免后期维护成本激增。 -- 设计决策与目录结构更新后，请同步修订本文件与相关文档，确保团队共享同一真相源，减少口头约定与隐式规则。 \ No newline at end of file +- 设计决策与目录结构更新后，请同步修订本文件与相关文档，确保团队共享同一真相源，减少口头约定与隐式规则。 + +--- + +# CLAUDE.md + +This file provides guidance to Claude series models when working with code in this repository. + +## Repository Overview + +This is the **Vibe Coding CN** repository, a workflow, toolset, and knowledge base for advanced AI-assisted programming. The project's core assets are its extensive `prompts` and `skills` libraries. + +## Key Commands + +### Prompt Library Management +```bash +# Enter the library directory +cd libs/external/prompts-library + +# Run the interactive conversion tool +python3 main.py +``` + +### Development & Maintenance +```bash +# Lint all markdown files in the repository +make lint + +# Create a full project backup (respects .gitignore) +bash backups/一键备份.sh +``` + +## Architecture & Structure + +### Core Directories +- **`prompts/`**: The core asset. A massive, well-organized library of prompts. + - `coding_prompts/`, `system_prompts/`, `user_prompts/` +- **`skills/`**: A modular library of skills for the AI, providing domain-specific knowledge for various tools like `ccxt`, `postgresql`, `telegram-dev`, +etc. +- **`documents/`**: The project's knowledge base, containing methodology, principles, and guides. +- **`libs/external/prompts-library/`**: A Python-based tool for converting prompts between Excel and Markdown formats. +- **`backups/`**: Scripts for project backups. +- **`libs/`**: Skeleton for shared Python library code. + +### Key Technical Details +1. **Prompt Organization**: Prompts use a `(row,col)_` prefix for categorization. +2. **Conversion Tool**: The `prompts-library` uses Python with `pandas` and `openpyxl`. +3. **Documentation Standard**: User-facing documentation is in Chinese. Code, file names, and structure are in English. +4. **Skills**: The `skills` directory provides context and knowledge for specific tools and domains, each with its own `SKILL.md`. + +## Development Workflow + +When modifying this repository: +1. Follow the existing prompt and skill categorization systems. +2. Use the `prompts-library` tool to maintain consistency when updating prompts. +3. Run `make lint` after changing any Markdown files. +4. Run a backup with `bash backups/一键备份.sh` before any major refactoring. + +--- + +# GEMINI.md - 项目上下文文档 (Project Context Document) + +## 项目概述 (Project Overview) + +`vibe-coding-cn` 项目旨在提供一个通过与 AI 结对编程实现“将想法变为现实”的终极工作流程。它强调“规划驱动”和“模块化”的核心理念，旨在避免 AI 失控导致的项目混乱。该项目不仅仅是一个代码库，更是一个全面的 AI 结对编程指南、庞大的提示词库和模块化的技能工具集，涵盖了从项目构思、技术选型、实施规划到具体开发、调试和扩展的全过程。 + +**核心理念:** 规划是核心，通过结构化、模块化的方式引导 AI，确保项目可控、可维护。 + +## 技术栈 (Technology Stack) + +本项目主要的技术栈和相关工具包括： + +* **核心语言:** Python (用于 `prompts-library` 工具和备份脚本) +* **CLI 交互:** `rich`, `InquirerPy` (用于 `prompts-library` 提供友好的命令行界面) +* **数据处理:** `pandas`, `openpyxl` (用于 `prompts-library` 处理 Excel 文件) +* **配置管理:** `PyYAML` (用于 `prompts-library` 的配置) +* **文档规范:** `markdownlint-cli` (用于 `Makefile` 中的 `lint` 任务) +* **版本控制:** Git +* **自动化:** Makefile +* **操作系统:** 兼容 Linux + +## 主要功能与工作流程 (Key Features & Workflow) + +1. **AI 提示词库 (`prompts/`):** + * 一个极其庞大和精细分类的提示词集合，是项目的核心资产。 + * `coding_prompts/`: 专注于编程和代码生成的提示词。 + * `system_prompts/`: 用于设定 AI 行为和思维框架的系统级提示词。 + * `user_prompts/`: 用户自定义或常用的提示词。 + +2. **提示词库管理工具 (`libs/external/prompts-library/`):** + * 提供 Python 工具 (`main.py`)，用于在 Excel 工作簿 (`prompt_excel/`) 和 Markdown 文档 (`prompt_docs/`) 之间进行提示词的相互转换。 + * 支持交互式和非交互式操作。 + +3. **技能库 (`skills/`):** + * 一个模块化的技能集合，为 AI 提供了特定工具和领域的知识。 + * 每个技能（如 `ccxt`, `postgresql`, `telegram-dev`）都包含独立的 `SKILL.md` 描述, 参考资料和脚本。 + +4. **项目备份工具 (`backups/`):** + * `快速备份.py` 脚本能根据 `.gitignore` 规则智能地打包项目文件为 `.tar.gz` 格式。 + +5. **知识库与文档 (`documents/`):** + * 包含代码组织、开发经验、系统提示词构建原则、项目架构模板等各类文档。 + +6. **外部工具与个人配置 (`libs/external/`):** + * 存放非核心项目代码但有用的外部工具、个人配置或实验性代码。例如：`my-nvim/` (nvim 配置), `XHS-image-to-PDF-conversion/` (图片转PDF工具)。 + +## 文件结构 (File Structure) + +``` +. +├── .gitignore # Git 版本控制忽略文件配置 +├── AGENTS.md # 面向 AI Agent 的贡献与行为准则。 +├── CLAUDE.md # 面向 Claude 模型的上下文与指令。 +├── CODE_OF_CONDUCT.md # 项目行为准则。 +├── CONTRIBUTING.md # 贡献指南。 +├── GEMINI.md # 面向 Gemini 模型的上下文与指令 (本文档)。 +├── LICENSE # 项目许可证。 +├── Makefile # 项目自动化脚本 (lint, backup 等)。 +├── README.md # 项目主文档，包含项目概览、使用指南等。 +│ +├── backups/ # 项目备份脚本。 +│ ├── 一键备份.sh # 一键备份脚本。 +│ └── 快速备份.py # 快速备份 Python 脚本。 +│ +├── documents/ # 存放各类说明文档、经验总结和配置。 +│ └── ... # 更多文档内容。 +│ +├── libs/ # 核心库代码。 +│ ├── common/ # 通用功能和工具库。 +│ │ ├── __init__.py # Python 包初始化文件。 +│ │ ├── models/ # 数据模型定义。 +│ │ └── utils/ # 实用工具函数。 +│ ├── database/ # 数据库相关代码。 +│ └── external/ # 外部工具、个人配置或实验性代码。 +│ ├── prompts-library/ # 提示词库管理工具 (Excel-Markdown 互转)。 +│ │ ├── main.py # 提示词库管理工具主程序。 +│ │ ├── requirements.txt # 工具依赖。 +│ │ ├── prompt_excel/ # Excel 格式提示词。 +│ │ ├── prompt_docs/ # Markdown 格式提示词文档。 +│ │ └── ... (其他 prompts-library 内部文件) +│ ├── my-nvim/ # 个人 Neovim 配置。 +│ └── XHS-image-to-PDF-conversion/ # 小红书图片转 PDF 工具。 +│ +├── prompts/ # 核心资产：AI 提示词库。 +│ ├── coding_prompts/ # 编程与代码生成相关提示词。 +│ ├── system_prompts/ # AI 系统级提示词。 +│ └── user_prompts/ # 用户自定义提示词。 +│ +└── skills/ # 模块化技能库。 + ├── ccxt/ # CCXT 加密货币交易库技能。 + ├── claude-code-guide/ # Claude Code 使用指南技能。 + ├── postgresql/ # PostgreSQL 数据库技能。 + ├── telegram-dev/ # Telegram Bot 开发技能。 + └── ... (其他 10+ 个技能) +``` \ No newline at end of file diff --git a/CLAUDE.md b/CLAUDE.md deleted file mode 100644 index e26e072..0000000 --- a/CLAUDE.md +++ /dev/null @@ -1,53 +0,0 @@ -# CLAUDE.md - -This file provides guidance to Claude series models when working with code in this repository. - -## Repository Overview - -This is the **Vibe Coding CN** repository, a workflow, toolset, and knowledge base for advanced AI-assisted programming. The project's core assets are its extensive `prompts` and `skills` libraries. - -## Key Commands - -### Prompt Library Management -```bash -# Enter the library directory -cd libs/external/prompts-library - -# Run the interactive conversion tool -python3 main.py -``` - -### Development & Maintenance -```bash -# Lint all markdown files in the repository -make lint - -# Create a full project backup (respects .gitignore) -bash backups/一键备份.sh -``` - -## Architecture & Structure - -### Core Directories -- **`prompts/`**: The core asset. A massive, well-organized library of prompts. - - `coding_prompts/`, `system_prompts/`, `user_prompts/` -- **`skills/`**: A modular library of skills for the AI, providing domain-specific knowledge for various tools like `ccxt`, `postgresql`, `telegram-dev`, -etc. -- **`documents/`**: The project's knowledge base, containing methodology, principles, and guides. -- **`libs/external/prompts-library/`**: A Python-based tool for converting prompts between Excel and Markdown formats. -- **`backups/`**: Scripts for project backups. -- **`libs/`**: Skeleton for shared Python library code. - -### Key Technical Details -1. **Prompt Organization**: Prompts use a `(row,col)_` prefix for categorization. -2. **Conversion Tool**: The `prompts-library` uses Python with `pandas` and `openpyxl`. -3. **Documentation Standard**: User-facing documentation is in Chinese. Code, file names, and structure are in English. -4. **Skills**: The `skills` directory provides context and knowledge for specific tools and domains, each with its own `SKILL.md`. - -## Development Workflow - -When modifying this repository: -1. Follow the existing prompt and skill categorization systems. -2. Use the `prompts-library` tool to maintain consistency when updating prompts. -3. Run `make lint` after changing any Markdown files. -4. Run a backup with `bash backups/一键备份.sh` before any major refactoring. \ No newline at end of file diff --git a/GEMINI.md b/GEMINI.md deleted file mode 100644 index 4d08536..0000000 --- a/GEMINI.md +++ /dev/null @@ -1,95 +0,0 @@ -# GEMINI.md - 项目上下文文档 (Project Context Document) - -## 项目概述 (Project Overview) - -`vibe-coding-cn` 项目旨在提供一个通过与 AI 结对编程实现“将想法变为现实”的终极工作流程。它强调“规划驱动”和“模块化”的核心理念，旨在避免 AI 失控导致的项目混乱。该项目不仅仅是一个代码库，更是一个全面的 AI 结对编程指南、庞大的提示词库和模块化的技能工具集，涵盖了从项目构思、技术选型、实施规划到具体开发、调试和扩展的全过程。 - -**核心理念:** 规划是核心，通过结构化、模块化的方式引导 AI，确保项目可控、可维护。 - -## 技术栈 (Technology Stack) - -本项目主要的技术栈和相关工具包括： - -* **核心语言:** Python (用于 `prompts-library` 工具和备份脚本) -* **CLI 交互:** `rich`, `InquirerPy` (用于 `prompts-library` 提供友好的命令行界面) -* **数据处理:** `pandas`, `openpyxl` (用于 `prompts-library` 处理 Excel 文件) -* **配置管理:** `PyYAML` (用于 `prompts-library` 的配置) -* **文档规范:** `markdownlint-cli` (用于 `Makefile` 中的 `lint` 任务) -* **版本控制:** Git -* **自动化:** Makefile -* **操作系统:** 兼容 Linux - -## 主要功能与工作流程 (Key Features & Workflow) - -1. **AI 提示词库 (`prompts/`):** - * 一个极其庞大和精细分类的提示词集合，是项目的核心资产。 - * `coding_prompts/`: 专注于编程和代码生成的提示词。 - * `system_prompts/`: 用于设定 AI 行为和思维框架的系统级提示词。 - * `user_prompts/`: 用户自定义或常用的提示词。 - -2. **提示词库管理工具 (`libs/external/prompts-library/`):** - * 提供 Python 工具 (`main.py`)，用于在 Excel 工作簿 (`prompt_excel/`) 和 Markdown 文档 (`prompt_docs/`) 之间进行提示词的相互转换。 - * 支持交互式和非交互式操作。 - -3. **技能库 (`skills/`):** - * 一个模块化的技能集合，为 AI 提供了特定工具和领域的知识。 - * 每个技能（如 `ccxt`, `postgresql`, `telegram-dev`）都包含独立的 `SKILL.md` 描述, 参考资料和脚本。 - -4. **项目备份工具 (`backups/`):** - * `快速备份.py` 脚本能根据 `.gitignore` 规则智能地打包项目文件为 `.tar.gz` 格式。 - -5. **知识库与文档 (`documents/`):** - * 包含代码组织、开发经验、系统提示词构建原则、项目架构模板等各类文档。 - -6. **外部工具与个人配置 (`libs/external/`):** - * 存放非核心项目代码但有用的外部工具、个人配置或实验性代码。例如：`my-nvim/` (nvim 配置), `XHS-image-to-PDF-conversion/` (图片转PDF工具)。 - -## 文件结构 (File Structure) - -``` -. -├── .gitignore # Git 版本控制忽略文件配置 -├── AGENTS.md # 面向 AI Agent 的贡献与行为准则。 -├── CLAUDE.md # 面向 Claude 模型的上下文与指令。 -├── CODE_OF_CONDUCT.md # 项目行为准则。 -├── CONTRIBUTING.md # 贡献指南。 -├── GEMINI.md # 面向 Gemini 模型的上下文与指令 (本文档)。 -├── LICENSE # 项目许可证。 -├── Makefile # 项目自动化脚本 (lint, backup 等)。 -├── README.md # 项目主文档，包含项目概览、使用指南等。 -│ -├── backups/ # 项目备份脚本。 -│ ├── 一键备份.sh # 一键备份脚本。 -│ └── 快速备份.py # 快速备份 Python 脚本。 -│ -├── documents/ # 存放各类说明文档、经验总结和配置。 -│ └── ... # 更多文档内容。 -│ -├── libs/ # 核心库代码。 -│ ├── common/ # 通用功能和工具库。 -│ │ ├── __init__.py # Python 包初始化文件。 -│ │ ├── models/ # 数据模型定义。 -│ │ └── utils/ # 实用工具函数。 -│ ├── database/ # 数据库相关代码。 -│ └── external/ # 外部工具、个人配置或实验性代码。 -│ ├── prompts-library/ # 提示词库管理工具 (Excel-Markdown 互转)。 -│ │ ├── main.py # 提示词库管理工具主程序。 -│ │ ├── requirements.txt # 工具依赖。 -│ │ ├── prompt_excel/ # Excel 格式提示词。 -│ │ ├── prompt_docs/ # Markdown 格式提示词文档。 -│ │ └── ... (其他 prompts-library 内部文件) -│ ├── my-nvim/ # 个人 Neovim 配置。 -│ └── XHS-image-to-PDF-conversion/ # 小红书图片转 PDF 工具。 -│ -├── prompts/ # 核心资产：AI 提示词库。 -│ ├── coding_prompts/ # 编程与代码生成相关提示词。 -│ ├── system_prompts/ # AI 系统级提示词。 -│ └── user_prompts/ # 用户自定义提示词。 -│ -└── skills/ # 模块化技能库。 - ├── ccxt/ # CCXT 加密货币交易库技能。 - ├── claude-code-guide/ # Claude Code 使用指南技能。 - ├── postgresql/ # PostgreSQL 数据库技能。 - ├── telegram-dev/ # Telegram Bot 开发技能。 - └── ... (其他 10+ 个技能) -``` \ No newline at end of file diff --git a/system_prompts/已经转移到 prompts 的文件夹中.md b/system_prompts/已经转移到 prompts 的文件夹中.md deleted file mode 100644 index acb78a5..0000000 --- a/system_prompts/已经转移到 prompts 的文件夹中.md +++ /dev/null @@ -1 +0,0 @@ -已经转移到 prompts 的文件夹中