소스 검색

feat: Add README.md to prompts/ and skills/ directories

tukuaiai 1 개월 전
부모
커밋
489f87b251
2개의 변경된 파일73개의 추가작업 그리고 0개의 파일을 삭제
  1. 33 0
      prompts/README.md
  2. 40 0
      skills/README.md

+ 33 - 0
prompts/README.md

@@ -0,0 +1,33 @@
+# 💡 AI 提示词库 (Prompts Library)
+
+`prompts/` 目录是本项目中 AI 提示词的核心资产,包含了大量经过精心设计和分类的提示词,用于指导 AI 进行各种任务,从代码生成到系统行为设定。这些提示词是实现高质量 AI 结对编程的关键。
+
+## 目录结构
+
+```
+prompts/
+├── coding_prompts/          # 编程与代码生成相关提示词
+├── system_prompts/          # AI 系统级提示词,用于设定 AI 行为和思维框架
+└── user_prompts/            # 用户自定义或常用的提示词
+```
+
+## 各子目录说明
+
+### `coding_prompts/`
+
+此目录存放专注于编程和代码生成任务的提示词。它们旨在帮助 AI 理解编程需求、生成符合规范的代码、进行代码分析、重构和调试等。这些提示词通常包含了对编程语言、框架、最佳实践和特定代码结构的详细指示。
+
+### `system_prompts/`
+
+此目录包含用于设定 AI 整体行为模式、思维框架和角色定位的系统级提示词。通过这些提示词,可以定义 AI 的个性、它与用户交互的方式、以及在解决问题时应遵循的原则。它们是确保 AI 能够以稳定、一致且符合预期的行为进行工作的基础。
+
+### `user_prompts/`
+
+此目录用于存放用户自定义或常用的提示词。这些提示词可以是个性化的任务指令、常用的查询模板或特定项目的工作流指南。用户可以根据自己的需求在此处添加和管理自己的提示词,以便于快速调用和复用。
+
+## 提示词的使用与管理
+
+*   **分类明确:** 提示词根据其用途被清晰地分类到不同的子目录中,方便查找和管理。
+*   **内容丰富:** 每个提示词都经过精心设计,以提供足够的信息和指导,确保 AI 能够准确理解任务。
+*   **持续优化:** 提示词是一个动态的知识库,可以根据实际使用效果和 AI 模型的演进进行持续的优化和更新。
+*   **结合工具:** 提示词可与 `libs/external/prompts-library` 中的提示词管理工具结合使用,进行 Excel 与 Markdown 格式的相互转换,实现更便捷的编辑和维护。

+ 40 - 0
skills/README.md

@@ -0,0 +1,40 @@
+# 🤖 AI 技能库 (Skills Library)
+
+`skills/` 目录是本项目中 AI 技能的模块化集合。每个子目录代表一个独立的技能模块,旨在为 AI 提供特定的工具、领域知识和操作能力。这些技能使得 AI 能够执行更复杂、更专业的任务。
+
+## 目录结构
+
+```
+skills/
+├───ccxt/                    # CCXT 加密货币交易库技能
+├───claude-code-guide/       # Claude Code 使用指南技能
+├───claude-cookbooks/        # Claude Cookbooks 技能
+├───claude-skills/           # Claude 核心技能
+├───coingecko/               # CoinGecko 数据查询技能
+├───cryptofeed/              # CryptoFeed 实时数据处理技能
+├───hummingbot/              # Hummingbot 量化交易机器人技能
+├───polymarket/              # Polymarket 预测市场技能
+├───postgresql/              # PostgreSQL 数据库操作技能
+├───proxychains/             # ProxyChains 代理工具技能
+├───snapdom/                 # SnapDOM 网页自动化技能
+├───telegram-dev/            # Telegram Bot 开发技能
+├───timescaledb/             # TimescaleDB 时序数据库技能
+└───twscrape/                # Twscrape 数据抓取技能
+```
+
+## 各技能模块说明
+
+每个技能模块通常包含以下内容:
+
+*   **`SKILL.md`**: 该技能的详细描述、功能、使用场景和限制。
+*   **`assets/`**: 与该技能相关的图像、图表或其他非代码资产。
+*   **`references/`**: 相关文档、API 文档链接、教程或其他参考资料。
+*   **`scripts/`**: 实现该技能的具体脚本或代码示例。
+
+## 如何使用技能
+
+AI Agent 在执行任务时,会根据任务需求调用相应的技能模块。开发者可以通过阅读每个技能模块内的 `SKILL.md` 文件,了解其具体功能和如何集成到 AI 的工作流程中。
+
+## 扩展与贡献
+
+本项目鼓励为 AI 技能库贡献新的技能模块。如果你有新的工具或领域知识希望集成到 AI 的能力中,可以创建一个新的子目录,并按照上述结构填充 `SKILL.md`、`assets/`、`references/` 和 `scripts/`。这有助于持续增强 AI 的能力和应用范围。