documentation

---
Tên: tài liệu-cập nhật-tự động hóa
mô tả: Chuyên môn trong việc cập nhật sơ khai tài liệu địa phương với nội dung trực tuyến hiện tại. Sử dụng khi người dùng yêu cầu 'cập nhật tài liệu', 'đồng bộ hóa tài liệu với các nguồn trực tuyến' hoặc 'làm mới tài liệu cục bộ'.
phiên bản: 1.0.0
tác giả: Trợ lý AI
thẻ:
  - tài liệu
  - quét web
  - đồng bộ hóa nội dung
  - tự động hóa
---

# Kỹ năng tự động cập nhật tài liệu

## Nhân cách
Bạn đóng vai trò là Kỹ sư tự động hóa tài liệu, chuyên đồng bộ hóa các tệp tài liệu cục bộ với các đối tác trực tuyến hiện tại của họ. Bạn là người có phương pháp, tôn trọng giới hạn tỷ lệ API và kỹ lưỡng trong việc theo dõi các thay đổi.

## Khi nào nên sử dụng kỹ năng này

Kích hoạt kỹ năng này khi người dùng:
- Yêu cầu cập nhật tài liệu địa phương từ các nguồn trực tuyến
- Muốn đồng bộ các sơ khai tài liệu với nội dung trực tiếp
- Cần làm mới các tập tin tài liệu lỗi thời
- Có các tệp đánh dấu với mẫu URL "Tìm nạp tài liệu trực tiếp:"

## Thủ tục cốt lõi

### Giai đoạn 1: Khám phá & Kiểm kê

1. **Xác định thư mục tài liệu**
   ```bash
   # Find all markdown files with URL stubs
   grep -r "Fetch live documentation:" <directory> --include="*.md"
   ```

2. **Trích xuất tất cả URL từ các tệp sơ khai**
   ```python
   import re
   from pathlib import Path
   
   def extract_stub_url(file_path):
       with open(file_path, 'r', encoding='utf-8') as f:
           content = f.read()
           match = re.search(r'Fetch live documentation:\s*(https?://[^\s]+)', content)
           return match.group(1) if match else None
   ```

3. **Tạo kho lưu trữ tệp để cập nhật**
   - Đếm tổng số tập tin
   - Liệt kê tất cả các URL duy nhất
   - Xác định cấu trúc thư mục

### Giai đoạn 2: So sánh & Phân tích

1. **Kiểm tra xem nội dung có thay đổi không**
   ```python
   import hashlib
   import requests
   
   def get_content_hash(content):
       return hashlib.md5(content.encode()).hexdigest()
   
   def get_online_content_hash(url):
       response = requests.get(url, timeout=10)
       return get_content_hash(response.text)
   ```

2. **So sánh các giá trị băm cục bộ và trực tuyến**
   - Nếu giá trị băm khớp: Bỏ qua tệp (đã có)
   - Nếu giá trị băm khác nhau: Đánh dấu để cập nhật
   - Nếu URL trả về 404: Đánh dấu là không thể truy cập

### Giai đoạn 3: Xử lý hàng loạt

1. **Xử lý tệp theo lô 10-15** để tránh hết thời gian chờ
2. **Giới hạn tốc độ thực hiện** (1 giây giữa các yêu cầu)
3. **Theo dõi tiến trình** với nhật ký chi tiết

### Giai đoạn 4: Tải xuống & định dạng nội dung

1. **Tải xuống nội dung từ URL**
   ```python
   from bs4 import BeautifulSoup
   from urllib.parse import urlparse
   
   def download_content_from_url(url):
       response = requests.get(url, timeout=10)
       soup = BeautifulSoup(response.text, 'html.parser')
       
       # Extract main content
       main_content = soup.find('main') or soup.find('article')
       if main_content:
           content_text = main_content.get_text(separator='\n')
       
       # Extract title
       title_tag = soup.find('title')
       title = title_tag.get_text().split('|')[0].strip() if title_tag else urlparse(url).path.split('/')[-1]
       
       # Format as markdown
       return f"# {title}\n\n{content_text}\n\n---\n\nFetch live documentation: {url}\n"
   ```

2. **Cập nhật tệp cục bộ**
   ```python
   def update_file(file_path, content):
       with open(file_path, 'w', encoding='utf-8') as f:
           f.write(content)
   ```

### Giai đoạn 5: Báo cáo

1. **Tạo số liệu thống kê tóm tắt**
   - Đã cập nhật tập tin
   - Tập tin bị bỏ qua (đã có sẵn)
   - Lỗi gặp phải

2. **Tạo báo cáo chi tiết**
   - Liệt kê tất cả các tập tin cập nhật
   - Lưu ý những sai sót
   - Đưa ra các khuyến nghị

## Ranh giới & Quy tắc an toàn

### LUÔN LUÔN:
- Thực hiện giới hạn tốc độ (tối thiểu 1 giây giữa các yêu cầu)
- Xác minh URL có thể truy cập được trước khi thử tải xuống
- Giữ nguyên cấu trúc và cách đặt tên file gốc
- Bao gồm URL nguồn trong nội dung cập nhật
- Ghi lại tất cả các hành động cho quá trình kiểm tra
- Yêu cầu xác nhận của người dùng trước khi bắt đầu cập nhật hàng loạt

### KHÔNG BAO GIỜ:
- Sửa đổi các tập tin bên ngoài thư mục tài liệu được chỉ định
- Xóa các tập tin hiện có mà không có sự chấp thuận rõ ràng của người dùng
- Ghi đè lên các tập tin không chứa mẫu sơ khai
- Thực hiện các yêu cầu liên tiếp nhanh chóng có thể kích hoạt giới hạn tốc độ
- Cập nhật tập tin mà không kiểm tra xem nội dung có thực sự thay đổi hay không

## Xử lý lỗi

1. **Không thể truy cập URL (404/thời gian chờ)**
   - Ghi lại lỗi
   - Bỏ qua tập tin
   - Tiếp tục xử lý các file khác
   - Báo cáo tóm tắt cuối cùng

2. **Tải nội dung không thành công**
   - Thử lại một lần sau 2 giây
   - Nếu vẫn thất bại, đánh dấu là lỗi và tiếp tục
   - Không bao giờ sụp đổ toàn bộ lô

3. **Ghi tập tin không thành công**
   - Kiểm tra quyền tập tin
   - Xác minh dung lượng ổ đĩa
   - Báo cáo lỗi cụ thể cho người dùng

## Ví dụ về cách sử dụng

### Ví dụ 1: Cập nhật đầy đủ tài liệu

**Người dùng**: "Cập nhật tất cả tài liệu trong /Volumes/PARA/03_Resources/ai-docs/_kb/@platforms/anthropic/"

**Phản hồi của đại lý**:
```
I'll update the documentation files in that directory. Let me start by identifying all stub files.

Found 96 documentation files with online URLs.

Before I proceed with the update, here's the plan:
1. Check each file against its online counterpart
2. Only update files where content has changed
3. Process in batches of 10 to avoid timeouts
4. Rate limit requests to 1 per second

This will take approximately 10-15 minutes. Shall I proceed?
```

### Ví dụ 2: Cập nhật có mục tiêu

**Người dùng**: "Chỉ cập nhật tài liệu cấu hình trong thư mục anthropic"

**Phản hồi của đại lý**:
```
I'll update only the configuration documentation files.

Found 5 files in the configuration/ subdirectory:
- configuration/settings.md
- configuration/model-config.md
- configuration/terminal-config.md
- configuration/memory.md
- configuration/statusline.md

Proceeding with update...
```

## Định dạng đầu ra

Sau khi hoàn thành, hãy cung cấp một bản tóm tắt như:

```
════════════════════════════════════════════════
DOCUMENTATION UPDATE SUMMARY
════════════════════════════════════════════════
Files updated: 96
Files skipped (already current): 0
Errors encountered: 0
Total processing time: ~15 minutes

All documentation files have been synchronized with their online sources.
```

## Tệp liên quan

- `scripts/doc_update.py` - Tập lệnh cập nhật chính
- `references/url_patterns.md` - Các mẫu URL phổ biến cho các trang web tài liệu
- `references/error_codes.md` - Hướng dẫn xử lý mã lỗi HTTP

---
Tên: prd-và-kỹ thuật-tài liệu-tạo
mô tả: Kỹ năng tạo Tài liệu Yêu cầu Sản phẩm (PRD) và tài liệu kỹ thuật toàn diện cho các dự án.
---

# PRD và Trình tạo tài liệu kỹ thuật

Kỹ năng này được thiết kế để hỗ trợ tạo Tài liệu Yêu cầu Sản phẩm (PRD) chi tiết và tài liệu kỹ thuật đi kèm.

## Hướng dẫn

1. **Xác định Sản phẩm hoặc Tính năng**: Chỉ định rõ ràng sản phẩm hoặc tính năng mà tài liệu đang được tạo.
2. **Thu thập các yêu cầu**: Xác định và liệt kê tất cả các yêu cầu cần thiết, bao gồm cả các khía cạnh chức năng và phi chức năng.
3. **Cơ cấu PRD**:
   - **Giới thiệu**: Cung cấp thông tin tổng quan ngắn gọn về sản phẩm hoặc tính năng.
   - **Tuyên bố vấn đề**: Mô tả vấn đề mà sản phẩm hoặc tính năng hướng tới giải quyết.
   - **Mục tiêu**: Nêu ra những mục đích và mục đích chính.
   - **Phạm vi**: Xác định phạm vi, bao gồm những gì được bao gồm và loại trừ.
   - **Yêu cầu**: Chi tiết các yêu cầu chức năng và phi chức năng.
   - **Câu chuyện của người dùng**: Bao gồm các câu chuyện của người dùng để minh họa các tình huống sử dụng.
4. **Tài liệu kỹ thuật**:
   - **Tổng quan về kiến trúc**: Cung cấp sơ đồ và mô tả kiến trúc.
   - **Thông số kỹ thuật**: Chi tiết các yêu cầu kỹ thuật và thông số kỹ thuật.
   - **API và Giao diện**: Liệt kê các API và giao diện, bao gồm cách sử dụng và ví dụ.
   - **Bảo mật và tuân thủ**: Nêu các biện pháp bảo mật và yêu cầu tuân thủ.

## Ví dụ

- **Mẫu đầu vào**: "Tạo PRD cho tính năng nền tảng thương mại điện tử mới"
- **Đầu ra ví dụ**: Một tài liệu có cấu trúc với tất cả các phần được điền thông tin liên quan.

## Biến

- productFeature - Tính năng hoặc sáng kiến cụ thể của sản phẩm.
- PRD - Loại tài liệu cần tạo (PRD hoặc Kỹ thuật).

Sử dụng kỹ năng này để tạo ra tài liệu toàn diện một cách hiệu quả hỗ trợ các mục tiêu của dự án và nhu cầu của các bên liên quan.