ADR Gen là một công cụ CLI dựa trên AI được thiết kế để tự động hóa việc tạo các Hồ sơ Quyết định Kiến trúc có cấu trúc nhằm ghi lại cơ sở lý luậ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-gen
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-gen 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.
ADR Gen là gì?
ADR Gen đơn giản hóa quy trình ghi lại 'lý do' đằng sau các lựa chọn cơ sở hạ tầng kỹ thuật và thiết kế phần mềm. Bằng cách tận dụng AI, nó giúp các nhà phát triển duy trì lịch sử rõ ràng về các quyết định, các lựa chọn thay thế đã xem xét và các đánh đổi kết quả, đảm bảo rằng các thành viên nhóm trong tương lai hiểu logic đằng sau cơ sở mã hiện tại. Là một phần của hệ sinh thái Openclaw Skills, nó cung cấp một cách liền mạch để nắm bắt kiến thức tổ chức mà không mất công soạn thảo tài liệu thủ công, biến các tuyên bố quyết định ngắn gọn thành các hồ sơ chuyên nghiệp.
Trường hợp sử dụng ADR Gen
- Ghi lại cơ sở lý luận đằng sau việc chọn các cơ sở dữ liệu hoặc nhà cung cấp đám mây cụ thể.
- Tài liệu hóa các thay đổi kiến trúc như chuyển từ REST sang GraphQL hoặc microservices.
- Chuẩn bị tài liệu toàn diện cho các buổi đánh giá kiến trúc và họp với các bên liên quan.
- Hướng dẫn các nhà phát triển mới bằng cách cung cấp lịch sử có thể tìm kiếm về các quyết định kỹ thuật và hệ quả của chúng.
Cách thức hoạt động của ADR Gen
- Người dùng cung cấp một tuyên bố quyết định và bối cảnh tùy chọn qua CLI bằng một lệnh duy nhất.
- AI phân tích tuyên bố để xác định vấn đề cốt lõi, các bên liên quan và ngăn xếp công nghệ cụ thể liên quan.
- Công cụ nghiên cứu các lựa chọn thay thế tiêu chuẩn ngành và đánh giá các đánh đổi kỹ thuật phổ biến liên quan đến lựa chọn.
- Một tài liệu Markdown có cấu trúc được tạo ra, chứa các phần tiêu chuẩn hóa cho Bối cảnh, Quyết định, Hệ quả và Trạng thái.
- Tệp kết quả được lưu vào thư mục đầu ra được chỉ định, sẵn sàng để tích hợp kiểm soát phiên bản trong môi trường Openclaw Skills của bạn.
Cài đặt ADR Gen
Để sử dụng công cụ này trong quy trình làm việc Openclaw Skills của bạn, hãy đảm bảo bạn đã cài đặt Node.js 18+. Không cần cài đặt thủ công vì nó chạy trực tiếp qua npx.
npx ai-adr "We chose PostgreSQL over MongoDB for our user data"
Để xem tất cả các tùy chọn cấu hình và trợ giúp, hãy sử dụng:
npx ai-adr --help
Lược đồ dữ liệu & Hệ thống phân loại của ADR Gen
ADR Gen sắp xếp đầu ra của nó vào các tệp Markdown có cấu trúc tuân theo các mẫu tài liệu kiến trúc tiêu chuẩn. Mỗi tệp thường bao gồm các siêu dữ liệu và các phần sau:
| Phần | Mô tả |
|---|---|
| Tiêu đề | Một tiêu đề súc tích phản ánh quyết định cụ thể đã được đưa ra. |
| Trạng thái | Trạng thái hiện tại của quyết định (ví dụ: Được đề xuất, Được chấp nhận, Bị thay thế). |
| Bối cảnh | Vấn đề kỹ thuật hoặc yêu cầu kinh doanh dẫn đến quyết định. |
| Quyết định | Giải pháp được chọn và lý do đằng sau việc chọn nó. |
| Hệ quả | Các kết quả dài hạn dự kiến, bao gồm các đánh đổi tích cực và tiêu cực. |
| Lựa chọn thay thế | Danh sách các công nghệ hoặc phương pháp tiếp cận khác đã được xem xét và lý do tại sao chúng bị từ chối. |
Tính năng Nâng cao của ADR Gen
- Chèn bối cảnh tùy chỉnh thông qua cờ --context để cung cấp cho AI các ràng buộc dự án hoặc chi tiết môi trường cụ thể.
- Quản lý đường dẫn đầu ra linh hoạt để tích hợp trực tiếp các hồ sơ vào các thư mục docs/adr/ hiện có hoặc các kho lưu trữ được kiểm soát phiên bản.
- Khả năng nghiên cứu tự động xác định các lựa chọn thay thế phổ biến trong ngành và các đánh đổi kỹ thuật hiện đại.
- Thực thi không cấu hình như một bổ sung nhẹ cho bộ công cụ Openclaw Skills dành cho các nhà phát triển.
SKILL.md
Đang tải
Các kỹ năng Openclaw liên quan
Trình tạo GitHub Action
Chuyển đổi các mô tả bằng ngôn ngữ tự nhiên thành các tệp YAML luồng công việc GitHub Actions đầy đủ chức năng và sẵn sàng cho sản xuất.
Công cụ Kiểm tra Khả năng Truy cập (a11y-auditor)
Một công cụ quét tự động giúp xác định các vi phạm WCAG trong HTML và JSX, đồng thời cung cấp các đề xuất sửa lỗi do AI hỗ trợ.
Trình khám phá dữ liệu Web3 (Chainbase)
Một công cụ mạnh mẽ để truy vấn và phân tích dữ liệu blockchain trên chuỗi theo thời gian thực trên nhiều mạng tương thích với EVM bằng API Chainbase.
GitHub Activity Feed (Nom)
Một kỹ năng mạnh mẽ để truy xuất và tóm tắt các feed hoạt động GitHub thời gian thực từ các kho lưu trữ hoặc tổ chức thông qua nền tảng Nom.
ADR Writer
Một tiện ích CLI giúp chuyển đổi các mô tả văn bản đơn giản thành Hồ sơ Quyết định Kiến trúc (ADR) có cấu trúc đầy đủ bằng cách sử dụng AI.
a11y-checker
Một công cụ CLI dựa trên AI giúp quét HTML và JSX để tìm các vấn đề về khả năng truy cập và cung cấp các bản sửa lỗi mã có thể sử dụng ngay.
Đặc sắc*
