Một công cụ đồng bộ hóa tài liệu tinh vi sử dụng phân tích git và cơ chế đồng thuận đa tác tử để đảm bảo mã nguồn và tài liệu luôn khớp hoàn hảo.
Cài đặt & Tải xuống
1. ClawHub CLI
Cách nhanh nhất để cài đặt kỹ năng trực tiếp từ thư viện.
npx clawhub@latest install contract-doc-sync
2. Cài đặt Thủ công
Sao chép thư mục kỹ năng vào một trong những vị trí sau
~/.openclaw/skills/ <project>/skills/ Ưu tiên: Không gian làm việc > Cục bộ > Gói sẵn
3. Cài đặt Prompt
Sao chép prompt này vào OpenClaw để tự động cài đặt.
Giúp tôi cài đặt contract-doc-sync bằng Clawhub. Nếu Clawhub chưa
Bạn muốn tải xuống?
Nhận các tệp kỹ năng gốc dưới dạng lưu trữ ZIP.
Contract Doc Sync là gì?
Contract Doc Sync là một kỹ năng chuyên biệt được thiết kế cho các nhà phát triển cần duy trì tài liệu có độ chính xác cao mà không tốn công sức thủ công. Bằng cách tích hợp trực tiếp vào hệ sinh thái Openclaw Skills, nó thu hẹp khoảng cách giữa mã nguồn và các tệp Markdown nằm trong thư mục docs. Kỹ năng này phân tích git diffs để phát hiện sự lệch tài liệu — các trường hợp triển khai đã phát triển vượt quá mô tả bằng văn bản của nó — và áp dụng các sửa chữa tự động để duy trì tính toàn vẹn của dự án.
Công cụ này được xây dựng trên nền tảng an toàn và chính xác, hoạt động cục bộ để bảo vệ quyền riêng tư của mã nguồn. Nó tập trung vào việc duy trì tài liệu kiến trúc, tài liệu tham khảo API và các quy ước mô-đun. Trong Openclaw Skills, nó đóng vai trò là một người viết tài liệu kỹ thuật tự động hiểu mối quan hệ giữa các bộ điều khiển (controllers), thực thể (entities) và các phần tài liệu tương ứng của chúng, đảm bảo rằng sự thật kỹ thuật của bạn vẫn nhất quán trên toàn bộ kho lưu trữ.
Trường hợp sử dụng Contract Doc Sync
- Tự động cập nhật các tệp Markdown tham khảo API sau khi sửa đổi chữ ký bộ điều khiển hoặc endpoints.
- Đồng bộ hóa các tài liệu thiết kế kỹ thuật và sơ đồ Mermaid bất cứ khi nào cấu trúc thực thể được tái cấu trúc.
- Thực hiện kiểm toán tính nhất quán của tài liệu trước khi gửi pull requests hoặc hợp nhất nhánh.
- Tạo báo cáo lệch tài liệu để xác định phần tài liệu nào đã lỗi thời so với các thay đổi mã nguồn mới nhất.
- Duy trì sự đồng bộ hóa tài liệu giữa các mô-đun trong các dự án Openclaw Skills phức tạp.
Cách thức hoạt động của Contract Doc Sync
- Giai đoạn 0 - Thăm dò môi trường: Kỹ năng phát hiện kiến trúc tài liệu dự án và stack công nghệ để xây dựng ProjectDocProfile.
- Giai đoạn 1 - Khám phá thay đổi: Thực hiện phân tích git diffs cục bộ dựa trên Python để xác định thay đổi mã nguồn nào ảnh hưởng đến các mục tiêu tài liệu cụ thể.
- Giai đoạn 2 - Sửa chữa đồng bộ hóa: Ánh xạ các thành phần mã nguồn đã thay đổi vào các phần tài liệu và áp dụng các chỉnh sửa chính xác cho các tệp Markdown bằng cách sử dụng section parser.
- Giai đoạn 3 - Xác minh đồng thuận: Triển khai nhiều tác tử phụ độc lập để xác minh tài liệu dựa trên ma trận 10 chiều, đảm bảo tính chính xác thông qua các lượt duyệt lặp lại.
- Giai đoạn 4 - Quét toàn cầu: Đối với đồng bộ hóa cấp cao (L3), nó thực hiện quét toàn diện tất cả các tài liệu hợp đồng để đảm bảo không còn sự lệch tài liệu trên toàn dự án.
Cài đặt Contract Doc Sync
Để triển khai kỹ năng này trong môi trường Openclaw Skills của bạn, hãy đảm bảo hệ thống cục bộ của bạn đáp ứng các yêu cầu sau:
# Xác minh các phụ thuộc cốt lõi đã được cài đặt
python3 --version
git --version
bash --version
# Tùy chọn: Cài đặt ripgrep để tối ưu hóa hiệu suất
rg --version
Kỹ năng này có khả năng tự cấu hình. Khi bạn kích hoạt các lệnh như sync docs hoặc check drift, tác tử sẽ tự động sử dụng $SKILL_DIR và các tập lệnh cục bộ để bắt đầu quá trình đồng bộ hóa. Không cần biến môi trường bên ngoài cho hoạt động tiêu chuẩn.
Lược đồ dữ liệu & Hệ thống phân loại của Contract Doc Sync
Kỹ năng này tổ chức các hoạt động của mình thông qua hệ thống siêu dữ liệu và lưu trữ có cấu trúc để đảm bảo Openclaw Skills có thể theo dõi mọi thay đổi:
| Phần tử dữ liệu | Định dạng | Mô tả |
|---|---|---|
| ProjectDocProfile | JSON | Định nghĩa docSystem, các quy tắc theo dõi và ánh xạ mã nguồn-tài liệu. |
| Drift Report | JSON | Ghi lại các tệp đã thay đổi, danh mục và tác động cụ thể đến tài liệu. |
| Section Parser | Shell Script | Một công cụ chuyên dụng để đọc và ghi chi tiết các phần Markdown. |
| Verification Matrix | Table | Theo dõi 10 chiều (D1-D10) bao gồm chữ ký API và logic ngữ nghĩa. |
| Audit Log | Markdown | Lịch sử chi tiết về các sửa chữa tự động, các thay đổi được đề xuất và các mục xem xét thủ công. |
Tính năng Nâng cao của Contract Doc Sync
- Giao thức đồng bộ hóa đa cấp: Chọn giữa L0 (Phát hiện), L1 (Đồng bộ nhanh), L2 (Đồng bộ đồng thuận) và L3 (Kiểm toán ngữ nghĩa sâu) tùy theo nhu cầu của bạn trong Openclaw Skills.
- Đồng thuận đa tác tử: Sử dụng giao thức xác minh nơi các tác tử phụ phải đạt được thỏa thuận về tính chính xác của tài liệu thông qua các lượt duyệt không có lỗi liên tiếp.
- Công cụ nhất quán ngữ nghĩa (D10): Sử dụng lập luận dựa trên LLM để xác minh rằng ngôn ngữ tự nhiên trong tài liệu của bạn khớp với logic kỹ thuật trong mã nguồn.
- Danh sách trắng bảo vệ ghi: Thực hiện ranh giới an toàn nghiêm ngặt chỉ cho phép sửa đổi trong các thư mục docs/, đảm bảo mã nguồn vẫn không bị thay đổi.
- Ghi đè cụ thể cho dự án: Cho phép các nhà phát triển xác định các quy tắc tài liệu tùy chỉnh trong AGENTS.md hoặc CLAUDE.md mà kỹ năng sẽ ưu tiên hơn so với cài đặt mặc định.
SKILL.md
Đang tải
Các kỹ năng Openclaw liên quan
AI chỉnh sửa video bằng văn bản
Một kỹ năng chỉnh sửa video hỗ trợ bởi AI giúp biến cảnh quay thô thành các clip chuyên nghiệp bằng cách sử dụng các lệnh văn bản ngôn ngữ tự nhiên đơn giản.
Chiến lược Tối ưu hóa Bản đồ
Một khung thuật toán hiệu suất cao để giải quyết các vấn đề phức tạp về đặt vật phẩm và tối ưu hóa ràng buộc trên lưới không gian.
SQLite Map Parser
Một tiện ích kỹ thuật để khám phá các lược đồ cơ sở dữ liệu SQLite và chuyển đổi dữ liệu quan hệ thành các bản đồ (map) hoặc mảng JSON có cấu trúc.
AI Video Maker Free Long
Một công cụ sản xuất video AI dựa trên đám mây giúp biến hình ảnh và kịch bản thô thành các video MP4 dài chuyên nghiệp với hiệu ứng chuyển cảnh và âm nhạc.
Trình tạo phụ đề bằng hình ảnh
Một kỹ năng sản xuất video hỗ trợ bởi AI, chuyển đổi hình ảnh tĩnh thành các clip MP4 1080p có phụ đề bằng kết xuất GPU từ xa.
Image to Video No Filter
Một kỹ năng AI hiệu suất cao giúp chuyển đổi hình ảnh tĩnh thành các clip video 1080p không bộ lọc bằng kết xuất GPU từ xa.
Đặc sắc*
