feat: 初始化 skills 仓库,添加 wiki 和 todo 两个 skill

- 添加 wiki skill:文档站管理,支持向 MkDocs 文档站添加/更新技术文档
  - SSH 连通性检查脚本
  - 文章模板参考(标准格式:摘要→核心概念→详解→代码→陷阱→练习题)
  - mkdocs.yml 导航结构参考
- 添加 todo skill:任务待办管理,通过自然语言操作 MySQL 待办事项
  - LRU 淘汰策略(基于 last_accessed_at)
  - MySQL MCP 配置指南及建表 SQL
  - 自然语言到 SQL 的映射规则
- 添加 README.md 说明文档
This commit is contained in:
2026-08-31 10:30:53 +08:00
commit be7720e732
7 changed files with 739 additions and 0 deletions
+123
View File
@@ -0,0 +1,123 @@
# 文章模板
本文档定义了文档站的标准文章格式。生成文档时必须遵循此模板。
## 文件命名规范
- 使用 kebab-case:`cache-breakdown.md`、`bloom-filter.md`
- 英文命名,内容用中文
- 放入对应主题目录(algorithm/、architecture/、project/ 等)
## 文章结构模板
```markdown
# 文章标题
!!! note "一句话摘要,概括本文核心内容"
---
## 核心概念
1. **概念一** — 简要说明
2. **概念二** — 简要说明
3. **概念三** — 简要说明
## 详解
### 原理/机制
用文字和图表解释核心原理。推荐使用 mermaid 图表:
```mermaid
graph TD
A[开始] --> B[处理]
B --> C[结束]
```
### 关键参数/配置
| 参数 | 说明 | 默认值 |
|------|------|--------|
| param1 | 描述 | value1 |
| param2 | 描述 | value2 |
### 对比分析(如有)
| 特性 | 方案 A | 方案 B |
|------|--------|--------|
| 特点1 | ... | ... |
## 代码示例
```go
// 以 Go 语言为主,注释用中文
func example() {
// 实现细节
}
```
## 常见陷阱
!!! warning "陷阱一"
描述常见错误及其规避方法。
!!! warning "陷阱二"
描述另一个需要注意的问题。
## 练习题
??? question "题目一:xxx?"
??? success "答案"
解答内容。
??? question "题目二:xxx?"
??? success "答案"
解答内容。
## 相关链接
- [链接名称](URL) — 简要说明
- [链接名称](URL) — 简要说明
```
## 各部分写作要点
### H1 标题
- 简洁明了,使用中文
- 不超过 20 个字
### note admonition(摘要)
- 一句话概括全文核心
- 让读者 3 秒内判断是否需要阅读
### 核心概念
- 3-5 个关键概念
- 每个概念一句话说明
- 有序列表
### 详解
- 分小节深入讲解
- 优先使用 mermaid 图表辅助说明(流程图、序列图、状态图)
- 用表格做对比和参数说明
- 代码块用于展示关键逻辑
- 详解部分是文章主体,应占全文 60% 以上
### 代码示例
- 完整可运行的 Go 代码
- 中文注释,解释关键逻辑
- 遵循 Go 命名规范(camelCase 变量,PascalCase 导出)
### 常见陷阱
- 使用 `!!! warning` admonition
- 每个陷阱说明:错误现象、原因、解决方案
- 2-4 个
### 练习题
- 使用 `??? question` 可折叠
- 答案用嵌套的 `??? success "答案"`
- 2-3 道题,覆盖文章核心知识点
### 相关链接
- 外部参考链接
- 每个链接附简要说明
+121
View File
@@ -0,0 +1,121 @@
# MkDocs 导航结构参考
本文档记录文档站的 mkdocs.yml 配置和导航组织规范。
## 导航结构
文档站的导航由 `mkdocs.yml` 的 `nav` 字段控制。文档本身不使用 YAML frontmatter。
### 当前目录结构
```
docs/
├── index.md # 首页
├── javascripts/mathjax.js # MathJax 配置
├── algorithm/ # 算法
│ ├── index.md # 章节首页
│ ├── bloom-filter.md
│ ├── bloom-filter-deletion.md
│ ├── counting-bloom-filter.md
│ ├── cuckoo-filter.md
│ ├── heavykeeper.md
│ ├── binary-tree-traversal.md
│ └── queue.md
├── architecture/ # 架构
│ ├── index.md
│ └── cache/
│ ├── index.md
│ ├── cache-breakdown.md
│ ├── cache-avalanche.md
│ └── cache-penetration.md
├── project/ # 项目
│ ├── index.md
│ ├── openapi-billing-architecture.md
│ ├── openapi-billing-resume.md
│ └── qdata/
│ ├── index.md
│ ├── architecture.md
│ ├── data-governance-etl.md
│ ├── deployment.md
│ └── resume.md
└── qiniu-cloud/ # 七牛云
├── index.md
├── architecture.md
├── ansible-automation.md
├── deployment-cicd.md
├── security-auth-data.md
└── resume-tech-points.md
```
### nav 格式示例
```yaml
nav:
- 首页: index.md
- 项目:
- 项目概述: project/index.md
- OpenAPI 计费:
- 架构设计: project/openapi-billing-architecture.md
- 简历亮点: project/openapi-billing-resume.md
- qData:
- 概述: project/qdata/index.md
- 架构设计: project/qdata/architecture.md
- 数据治理: project/qdata/data-governance-etl.md
- 部署方案: project/qdata/deployment.md
- 简历亮点: project/qdata/resume.md
- 架构:
- 架构概述: architecture/index.md
- 缓存:
- 缓存概述: architecture/cache/index.md
- 缓存击穿: architecture/cache/cache-breakdown.md
- 缓存雪崩: architecture/cache/cache-avalanche.md
- 缓存穿透: architecture/cache/cache-penetration.md
- 算法:
- 算法概述: algorithm/index.md
- 布隆过滤器: algorithm/bloom-filter.md
- 布隆过滤器删除: algorithm/bloom-filter-deletion.md
- 计数布隆过滤器: algorithm/counting-bloom-filter.md
- 布谷鸟过滤器: algorithm/cuckoo-filter.md
- HeavyKeeper: algorithm/heavykeeper.md
- 二叉树遍历: algorithm/binary-tree-traversal.md
- 队列: algorithm/queue.md
- 七牛云:
- 概述: qiniu-cloud/index.md
- 架构设计: qiniu-cloud/architecture.md
- Ansible 自动化: qiniu-cloud/ansible-automation.md
- 部署与 CI/CD: qiniu-cloud/deployment-cicd.md
- 安全与认证: qiniu-cloud/security-auth-data.md
- 简历技术亮点: qiniu-cloud/resume-tech-points.md
```
## 添加新文档的步骤
1. **确定章节**:新文档属于哪个顶级章节(algorithm/architecture/project/qiniu-cloud)?是否有子章节?
2. **创建文件**:在对应目录下创建 `.md` 文件(kebab-case 命名)
3. **更新 nav**:在 `mkdocs.yml` 的 `nav` 中对应位置添加条目
4. **更新 index.md**(如需):如果是新子章节,可能需要更新章节的 `index.md`
## Section Index 规范
每个章节目录下的 `index.md` 是该章节的首页/概述页。使用 MkDocs Material 的 `navigation.indexes` 功能:
```yaml
# mkdocs.yml 中启用
theme:
features:
- navigation.indexes
```
`index.md` 通常包含:
- H1 标题(章节名称)
- 一句话概述
- 子文章的链接表格(如有子文章)
## 命名规范
| 类型 | 规范 | 示例 |
|------|------|------|
| 目录名 | 小写 kebab-case | `architecture/`、`qiniu-cloud/` |
| 文件名 | 小写 kebab-case | `cache-breakdown.md` |
| 章节标题 | 中文 | `# 缓存击穿` |
| nav 标签 | 中文 | `缓存击穿: architecture/cache/cache-breakdown.md` |