chore: Remove outdated skill standardization workflow documentation
- Deleted the chuan-hoa-skills.md file, which contained an obsolete workflow for standardizing Agent Skills according to the skill-authoring template. - This removal helps streamline the documentation by eliminating outdated practices and focusing on current standards for skill development.
This commit is contained in:
Ho Ngoc Hai
@@ -1,241 +0,0 @@
|
||||
---
|
||||
description: Chuẩn hóa Agent Skills theo template skill-authoring
|
||||
---
|
||||
|
||||
# Workflow Chuẩn Hoá Skills
|
||||
|
||||
Workflow này hướng dẫn cách chuẩn hóa một Agent Skill theo template `skill-authoring`.
|
||||
|
||||
> **QUAN TRỌNG**: Skill phải phù hợp với kiến trúc .NET của dự án GoodGo. Cần nghiên cứu services thực tế trước khi viết.
|
||||
|
||||
## Bước 1: Đọc skill-authoring template
|
||||
|
||||
// turbo
|
||||
Đọc file template để hiểu cấu trúc chuẩn:
|
||||
```
|
||||
view_file .agent/skills/skill-authoring/SKILL.md
|
||||
```
|
||||
|
||||
## Bước 2: Nghiên cứu kiến trúc dự án
|
||||
|
||||
// turbo
|
||||
Xem danh sách services trong dự án:
|
||||
```
|
||||
list_dir services/
|
||||
```
|
||||
|
||||
**Chọn 1-2 services để nghiên cứu patterns thực tế:**
|
||||
- Controllers: `services/[service-name]/src/*/Controllers/`
|
||||
- DTOs: `services/[service-name]/src/*/Application/`
|
||||
- Domain: `services/[service-name]/src/*/Domain/`
|
||||
|
||||
Ghi nhớ các patterns:
|
||||
- Clean Architecture: API / Domain / Infrastructure
|
||||
- MediatR CQRS pattern
|
||||
- `ApiResponse<T>` wrapper
|
||||
- API Versioning: `[ApiVersion("1.0")]`
|
||||
- Swagger annotations
|
||||
- Bilingual XML comments (EN/VI)
|
||||
|
||||
## Bước 3: Phân tích skill cần chuẩn hóa
|
||||
|
||||
// turbo
|
||||
Đọc skill cần chuẩn hóa:
|
||||
```
|
||||
view_file .agent/skills/[skill-name]/SKILL.md
|
||||
```
|
||||
|
||||
// turbo
|
||||
Kiểm tra thư mục skill có references/ hoặc scripts/:
|
||||
```
|
||||
list_dir .agent/skills/[skill-name]/
|
||||
```
|
||||
|
||||
## Bước 4: Kiểm tra cấu trúc & code patterns
|
||||
|
||||
### 4.1 Checklist cấu trúc SKILL.md:
|
||||
|
||||
- [ ] Frontmatter đầy đủ: `name`, `description`, `metadata.author`, `metadata.version`
|
||||
- [ ] Có section "When to Use This Skill / Khi Nào Sử Dụng"
|
||||
- [ ] Có section "Core Concepts / Khái Niệm Cốt Lõi" (nếu applicable)
|
||||
- [ ] Có section "Key Patterns / Mẫu Chính" với code examples
|
||||
- [ ] Có section "Common Mistakes / Lỗi Thường Gặp" với ❌ BAD / ✅ GOOD examples
|
||||
- [ ] Có section "Quick Reference / Tham Chiếu Nhanh" với bảng tóm tắt
|
||||
- [ ] Có section "Resources / Tài Nguyên" với links đến related skills
|
||||
- [ ] Headings có bilingual format: `## English / Tiếng Việt`
|
||||
|
||||
### 4.2 Checklist code patterns (.NET):
|
||||
|
||||
- [ ] Code examples dùng C# / ASP.NET Core (KHÔNG PHẢI TypeScript/Express)
|
||||
- [ ] Dùng `ApiResponse<T>` wrapper cho responses
|
||||
- [ ] Dùng MediatR pattern (Commands/Queries/Handlers)
|
||||
- [ ] Dùng record types cho DTOs
|
||||
- [ ] Dùng `[ApiVersion]`, `[SwaggerOperation]`, `[SwaggerResponse]`
|
||||
- [ ] XML comments có bilingual (EN/VI)
|
||||
|
||||
### 4.3 Kiểm tra references/ folder:
|
||||
|
||||
Nếu có `references/REFERENCE.md`:
|
||||
- [ ] Đã chuyển sang .NET patterns chưa?
|
||||
- [ ] Nếu còn TypeScript/Express → Phải viết lại
|
||||
|
||||
## Bước 5: Viết lại skill theo template
|
||||
|
||||
### 5.1 SKILL.md Template:
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: skill-name
|
||||
description: Mô tả skill. Use for X, Y, Z.
|
||||
compatibility: ".NET 8+, ASP.NET Core, MediatR"
|
||||
metadata:
|
||||
author: Velik Ho
|
||||
version: "1.0"
|
||||
---
|
||||
|
||||
# Skill Title / Tiêu Đề Skill
|
||||
|
||||
Brief introduction / Giới thiệu ngắn.
|
||||
|
||||
## When to Use This Skill / Khi Nào Sử Dụng
|
||||
|
||||
Use this skill when:
|
||||
- Condition 1 / Điều kiện 1
|
||||
- Condition 2 / Điều kiện 2
|
||||
|
||||
## Core Concepts / Khái Niệm Cốt Lõi
|
||||
|
||||
### Concept 1
|
||||
Explanation...
|
||||
|
||||
## Key Patterns / Mẫu Chính
|
||||
|
||||
### Pattern Name
|
||||
|
||||
```csharp
|
||||
/// <summary>
|
||||
/// EN: Description in English.
|
||||
/// VI: Mô tả bằng tiếng Việt.
|
||||
/// </summary>
|
||||
public class ExampleClass
|
||||
{
|
||||
// EN: Comment in English
|
||||
// VI: Comment bằng tiếng Việt
|
||||
}
|
||||
```
|
||||
|
||||
## Common Mistakes / Lỗi Thường Gặp
|
||||
|
||||
### 1. Mistake Name
|
||||
|
||||
```csharp
|
||||
// ❌ BAD: Wrong approach
|
||||
wrongCode();
|
||||
|
||||
// ✅ GOOD: Correct approach
|
||||
correctCode();
|
||||
```
|
||||
|
||||
## Quick Reference / Tham Chiếu Nhanh
|
||||
|
||||
| Category | Standard |
|
||||
|----------|----------|
|
||||
| Item 1 | Value 1 |
|
||||
|
||||
## Resources / Tài Nguyên
|
||||
|
||||
- [Related Skill](../related-skill/SKILL.md)
|
||||
- [Skill Authoring](../skill-authoring/SKILL.md)
|
||||
```
|
||||
|
||||
### 5.2 references/REFERENCE.md Template (nếu có):
|
||||
|
||||
```markdown
|
||||
# Skill Name - Detailed Reference
|
||||
|
||||
Detailed code examples using ASP.NET Core patterns.
|
||||
|
||||
## Section 1
|
||||
|
||||
```csharp
|
||||
// C# code examples with bilingual comments
|
||||
```
|
||||
|
||||
## Resources / Tài Nguyên
|
||||
|
||||
- [ASP.NET Core Docs](https://docs.microsoft.com/en-us/aspnet/core/)
|
||||
```
|
||||
|
||||
## Bước 6: Tối ưu độ dài
|
||||
|
||||
- Rút gọn nội dung dư thừa
|
||||
- Giữ body content < 5000 tokens
|
||||
- Loại bỏ examples trùng lặp
|
||||
- Giữ lại patterns quan trọng nhất
|
||||
|
||||
## Bước 7: Verify kết quả
|
||||
|
||||
// turbo
|
||||
Đọc lại file đã chuẩn hóa:
|
||||
```
|
||||
view_file .agent/skills/[skill-name]/SKILL.md
|
||||
```
|
||||
|
||||
Nếu có references/:
|
||||
```
|
||||
view_file .agent/skills/[skill-name]/references/REFERENCE.md
|
||||
```
|
||||
|
||||
### Checklist cuối cùng:
|
||||
|
||||
**SKILL.md:**
|
||||
- [ ] Frontmatter đầy đủ với author: Velik Ho
|
||||
- [ ] Có đủ 5-6 sections chính
|
||||
- [ ] Bilingual headings nhất quán
|
||||
- [ ] Code examples dùng C# / .NET
|
||||
- [ ] Common Mistakes có ❌/✅ format
|
||||
- [ ] Quick Reference có bảng tóm tắt
|
||||
- [ ] Resources link đến skill-authoring
|
||||
|
||||
**references/ (nếu có):**
|
||||
- [ ] Đã chuyển sang .NET patterns
|
||||
- [ ] Code examples dùng C# với bilingual comments
|
||||
|
||||
## Bước 8: Cập nhật workflow progress
|
||||
|
||||
Đánh dấu skill đã hoàn thành trong danh sách bên dưới.
|
||||
|
||||
---
|
||||
|
||||
## Danh Sách Skills
|
||||
|
||||
### ✅ Đã chuẩn hóa:
|
||||
- [x] skill-authoring
|
||||
- [x] documentation
|
||||
- [x] comment-code
|
||||
- [x] api-design (+ references/)
|
||||
- [x] project-rules
|
||||
- [x] security
|
||||
|
||||
### ⏳ Cần chuẩn hóa (20 skills):
|
||||
- [ ] api-gateway-advanced
|
||||
- [ ] api-versioning-strategy
|
||||
- [ ] caching-patterns
|
||||
- [ ] cicd-advanced-patterns
|
||||
- [ ] configuration-management
|
||||
- [ ] data-consistency-patterns
|
||||
- [ ] database-prisma
|
||||
- [ ] deployment-kubernetes
|
||||
- [ ] error-handling-patterns
|
||||
- [ ] event-driven-architecture
|
||||
- [ ] infrastructure-as-code
|
||||
- [ ] inter-service-communication
|
||||
- [ ] microservices-development-process
|
||||
- [ ] middleware-patterns
|
||||
- [ ] observability-monitoring
|
||||
- [ ] performance-optimization
|
||||
- [ ] repository-pattern
|
||||
- [ ] resilience-patterns
|
||||
- [ ] service-discovery-registry
|
||||
- [ ] service-layer-patterns
|
||||
- [ ] testing-patterns
|
||||
Reference in New Issue
Block a user