Một công cụ chuyên dụng để phân tích mã nguồn và các cuộc hội thoại nhằm ghi lại lý luận chiến lược đằng sau các lựa chọn kỹ thuật.
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 adr-generator
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 adr-generator 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.
Architecture Decision Record Generator là gì?
ADR Generator là một công cụ lập tài liệu kỹ thuật được thiết kế để nắm bắt bối cảnh và lý do đằng sau các lựa chọn kiến trúc quan trọng. Bằng cách tận dụng khả năng này của Openclaw Skills, các nhóm phát triển có thể tạo ra một bản ghi vĩnh viễn về lý do tại sao các framework, cơ sở dữ liệu hoặc quy ước cụ thể được chọn, giúp ngăn chặn các cuộc tranh luận lặp đi lặp lại và làm giảm bớt quá trình làm quen cho các thành viên mới.
Kỹ năng này tự động hóa việc khám phá bối cảnh lịch sử thông qua nhật ký git và phân tích mã nguồn, đảm bảo rằng các Architecture Decision Records (ADRs) được dựa trên sự thật kỹ thuật. Nó tuân theo định dạng Michael Nygard tiêu chuẩn ngành để duy trì tính nhất quán và rõ ràng trong suốt vòng đời của tài liệu.
Trường hợp sử dụng Architecture Decision Record Generator
- Ghi lại việc lựa chọn một cơ sở dữ liệu, framework hoặc thư viện chính mới.
- Lưu lại các hợp đồng API và định nghĩa schema dữ liệu để tham khảo trong tương lai.
- Chính thức hóa các quy ước của nhóm như chiến lược kiểm thử hoặc mô hình phân nhánh.
- Ghi lại các sự đánh đổi được thực hiện trong các giai đoạn phát triển áp lực cao.
- Tạo nhật ký lịch sử về việc áp dụng hoặc ngừng sử dụng công cụ trong một dự án.
Cách thức hoạt động của Architecture Decision Record Generator
- Xác định quyết định cốt lõi bằng cách trích xuất thông tin chính từ các cuộc hội thoại hiện tại hoặc đánh giá mã.
- Tái cấu trúc bối cảnh bằng cách quét lịch sử git và tài liệu hiện có để tìm các thay đổi và từ khóa liên quan.
- Phân tích các phương án thay thế bằng cách đánh giá dấu vết của các thử nghiệm, spikes hoặc các tham chiếu phụ thuộc đã bị xóa.
- Đánh giá hệ quả bằng cách tìm kiếm trong mã nguồn về độ sâu triển khai, các giải pháp tạm thời hoặc nợ kỹ thuật.
- Tạo ADR cuối cùng bằng cách sử dụng mẫu markdown có cấu trúc bao gồm trạng thái, người quyết định và tài liệu tham khảo.
Cài đặt Architecture Decision Record Generator
Để khởi tạo thư mục ADR và bắt đầu theo dõi các quyết định bằng Openclaw Skills, hãy sử dụng các lệnh sau:
Kỹ năng này sẽ tự động phát hiện các đường dẫn tiêu chuẩn như `docs\/decisions\/` hoặc `architecture\/` trong giai đoạn phân tích của nó.
Lược đồ dữ liệu & Hệ thống phân loại của Architecture Decision Record Generator
ADR Generator tổ chức dữ liệu bằng cách sử dụng phân loại dựa trên tệp, tuần tự để đảm bảo tính bất biến và quản lý phiên bản dễ dàng.
| Tính năng | Quy cách |
|---|---|
| Định dạng tệp | Markdown (.md) |
| Quy ước đặt tên | NNNN-short-noun-phrase.md (ví dụ: 0001-use-postgresql.md) |
| Vị trí | docs\/adr\/ hoặc doc\/architecture\/ |
| Tệp chỉ mục | Một tệp README.md chứa bảng tóm tắt tất cả các quyết định, trạng thái và ngày tháng. |
| Mẫu | Định dạng Michael Nygard (Bối cảnh, Quyết định, Thay thế, Hệ quả). |
Tính năng Nâng cao của Architecture Decision Record Generator
- Pháp y Git tự động: Sử dụng bộ lọc git nâng cao để tìm thời điểm các phụ thuộc được thêm vào hoặc xóa bỏ nhằm tái tạo dòng thời gian quyết định.
- Khám phá phương án thay thế theo kinh nghiệm: Quét các từ khóa như 'experiment' hoặc 'poc' trong các thông điệp commit để tìm các đường hướng kỹ thuật đã bị loại bỏ.
- Bản đồ tác động: Định lượng mức độ sâu sắc của một lựa chọn bằng cách đếm các lượt import dành riêng cho framework trong toàn bộ mã nguồn.
- Theo dõi sự thay thế: Tự động quản lý vòng đời của các quyết định bằng cách liên kết các ADR mới với các bản ghi mà chúng thay thế.
- Tích hợp đa Agent: Có thể được kích hoạt bởi các Agent khác trong quá trình đánh giá PR hoặc các phiên thảo luận kiến trúc.
SKILL.md
Đang tải
Các kỹ năng Openclaw liên quan
Client Report Generator
Một công cụ báo cáo tự động chuyển đổi dữ liệu CSV, JSON và phân tích thô thành các tài liệu chuyên nghiệp, có cấu trúc hướng tới khách hàng.
Cloud Tagging Enforcer
Một công cụ quản trị đám mây toàn diện để kiểm tra các tag tài nguyên, thực thi các lược đồ tuân thủ và tạo các tập lệnh khắc phục trên các nhà cung cấp đám mây lớn.
Trình kiểm tra Prompt Injection
Một công cụ kiểm tra bảo mật toàn diện được thiết kế để mô phỏng các cuộc tấn công đối kháng và tăng cường khả năng chống lại Prompt Injection cho các ứng dụng dựa trên LLM.
Site Health Monitor
Một công cụ giám sát toàn diện để theo dõi thời gian hoạt động của trang web, tình trạng chứng chỉ SSL và thời gian phản hồi của máy chủ.
Astro Project Analyzer
Một công cụ kiểm tra toàn diện được thiết kế để tối ưu hóa các dự án Astro về tốc độ, các thực hành cấu hình tốt nhất và khả năng hiển thị trên công cụ tìm kiếm.
Công cụ xác thực Cargo.toml
Một tiện ích chuyên dụng để kiểm tra các tệp kê khai Rust Cargo.toml nhằm đảm bảo tính chính xác về cấu trúc, bảo mật phụ thuộc và tính sẵn sàng cho crates.io.
Đặc sắc*
