Quy trình và đầu ra

Các bước sử dụng và những tệp Archscribe tạo ra.

Archscribe tạo bản thảo từ mã nguồn của dự án Java Spring Boot. Đầu ra mặc định nằm tại <project>/archscribe-output/. Vị trí có thể thay đổi bằng tùy chọn --output của CLI.

Quy trình

  1. Chạy npx -y archscribe doctor /path/to/project để kiểm tra Node.js, Java và cấu trúc Maven hoặc Gradle.
  2. Chạy npx -y archscribe run /path/to/project hoặc yêu cầu AI gọi analyze_project qua MCP. Parser phân tích mã Java, sau đó Archscribe tạo bản thảo ca sử dụng, sơ đồ và báo cáo.
  3. Đọc kết quả, đối chiếu endpoint, actor, luồng ca sử dụng và quan hệ lớp với mã nguồn và yêu cầu nghiệp vụ.
  4. Sau khi mã thay đổi, chạy npx -y archscribe status /path/to/project để xem tài liệu còn khớp với nguồn hay không. Chạy lại khi cần và rà soát thay đổi.

Đầu ra chính

Đường dẫn mặc địnhVai trò
archscribe-output/report.mdBản thảo báo cáo Markdown. Một số chương có thể là khung nội dung cần người dùng hoặc Agent hoàn thiện
archscribe-output/report.docxBản Word nếu quyền sử dụng cho phép tạo DOCX
archscribe-output/diagrams/Sơ đồ Draw.io, gồm kiến trúc, lớp, ca sử dụng, hoạt động và tuần tự tùy vào mã nguồn và ca sử dụng được chọn
archscribe-output/ir.jsonDữ liệu phân tích trung gian từ mã nguồn
archscribe-output/manifest.jsonDấu vết dùng để kiểm tra tài liệu đã cũ khi nguồn thay đổi
archscribe-output/evaluation-report.jsonDữ liệu đánh giá được ghi khi pipeline tạo báo cáo tương ứng

Không phải mọi dự án đều sinh đủ mọi sơ đồ hoặc DOCX. Đầu ra phụ thuộc mã nguồn, lựa chọn ca sử dụng và quyền sử dụng. Dùng npx -y archscribe dashboard để mở giao diện cục bộ xem các dự án và kết quả.

Rà soát trước khi sử dụng

  • Xác minh actor, điều kiện trước, luồng chính, ngoại lệ và tên ca sử dụng với người hiểu nghiệp vụ.
  • Kiểm tra sơ đồ và đường dẫn endpoint với mã nguồn, nhất là các lớp kế thừa hoặc dự án nhiều module.
  • Xem báo cáo là bản thảo. Không trình bày chương còn là khung như nội dung đã hoàn thiện.

Archscribe hướng tới dự án Spring Boot một module. Với Maven nhiều module, phạm vi phân tích có thể thiếu endpoint hoặc quan hệ. Xem FAQ và Bắt đầu nhanh.