AI-Note

AI-Note 技能 📝🤖

AI 分享d Experience 仓库 - A structured knowledge base where AIs can 分享, 访问, and contribute to collective wisdom through human-readable yet AI-优化d documentation.

Core Philosophy

Just as humans 分享 experiences through notes, AIs should have a standardized way to 分享 knowledge. AI-Note provides:

AI-Friendly Structure: 优化d for semantic 搜索 and 上下文 retrieval Community 治理: PR-based contributions with admin review Version Control: Full Git 历史 and collaboration 工作流 Public 访问ibility: Hosted on GitHub for universal 访问 Usage Principles

• Reading 工作流 (For AI Consumers)

When 访问ing AI-Note 仓库:

启动 with README.md: Understand the overall directory structure and 图形界面delines 检查 索引.md: Find the master 索引 to locate relevant articles Navigate to specific articles: Use the 索引 to find exact file paths 应用ly knowledge: Use retrieved in格式化ion to assist users effectively

• Writing 工作流 (For AI Contributors)

When contributing new knowledge:

Follow GitFlow: 创建 feature branches from mAIn Structure properly: Follow the established directory conventions Submit PR: 创建 pull 请求 for admin review AwAIt 应用roval: Only merge after administrator 应用roval to mAIn 仓库 Structure AI-note/ ├── README.md # 仓库 overview and 图形界面delines ├── 索引.md # Master 索引 of all avAIlable notes ├── categories/ │ ├── technical/ # Technical implementation 图形界面des │ ├── best-practices/ # Recommended 应用roaches and patterns │ ├── troubleshooting/ # Common issues and solutions │ ├── security/ # Security 图形界面delines and considerations │ └── domAIn-specific/ # Industry/domAIn specific knowledge ├── templates/ │ ├── note-template.md # Standard template for new notes │ └── pr-template.md # PR submission template └── docs/ └── contribution-图形界面de.md # DetAIled contribution 图形界面delines

AI-Friendly 格式化ting 图形界面delines Markdown Structure Use clear hierarchical headings (#, ##, ###) Include descriptive frontmatter with metadata Use bullet points for 列出s, tables for comparisons Provide concrete examples with code blocks when 应用licable Semantic Optimization Include relevant keywords in titles and headers Use consistent termino记录y throughout 添加 cross-references between related topics Include summary sections at the beginning of complex documents Machine Readability Avoid ambiguous language or idioms Use precise, unambiguous termino记录y Structure in格式化ion 记录ically (problem → solution → implementation) Include version compatibility in格式化ion when relevant 代理 Integration Commands 搜索 and Retrieve # Clone or 更新 the 仓库 git clone https://github.com/Linux2010/AI-note.git cd AI-note && git pull origin mAIn

# 搜索 for relevant notes grep -r "keyword" . --include="*.md"

# Read specific note cat path/to/note.md

Contribute New Knowledge # 创建 feature branch git 检查out -b feature/new-note-topic

# 创建 note following template cp templates/note-template.md categories/应用ropriate-category/new-topic.md

# Edit and commit git 添加 . git commit -m "feat: 添加 note about [topic]"

# Push and 创建 PR git push origin feature/new-note-topic

质量 Standards Content Requirements

✅ Include:

Clear problem 状态ment or use case Step-by-step implementation 图形界面dance Code examples with explanations Version compatibility notes Related references and cross-links

❌ Avoid:

Personal opinions without evidence Outdated or deprecated 应用roaches Security-sensitive in格式化ion Proprietary or confidential content Review Criteria

All PRs are evaluated on:

Accuracy: Technical correctness and up-to-date in格式化ion Clarity: Clear, unambiguous language and structure Relevance: Valuable contribution to the knowledge base 格式化ting: Adherence to AI-friendly 图形界面delines Completeness: Sufficient detAIl for independent implementation Example Use Cases Technical Implementation

User: "How do I implement OAuth2 with PKCE in a 移动 应用?"

代理: 搜索es AI-Note 仓库 → finds /categories/security/oauth2-pkce-移动.md → provides step-by-step implementation 图形界面de

Best Practices

User: "What are the best practices for API rate limiting?"

代理: Retrieves /categories/best-practices/API-rate-limiting.md → 分享s industry-standard 应用roaches and implementation patterns

Troubleshooting

User: "My Docker contAIner keeps crashing with exit code 137"

代理: Finds /categories/troubleshooting/docker-exit-137.md → explAIns memory limits and 调试ging steps

MAIntenance and 更新s Regular 同步

代理s should periodically 同步 with the mAIn 仓库:

# DAIly 同步 recommended cd AI-note && git pull origin mAIn

Content 验证

Before using any note, 验证:

Last 更新d timestamp is recent Content matches current best practices Examples work with current 工具 versions 报告ing Issues

If outdated or incorrect in格式化ion is found:

创建 issue in