Workflows
Khó⏱ 3–6 giờ🔧 3 AI Agent
Tự động tạo tài liệu kỹ thuật từ mã nguồn
Quy trình AI tự động đọc cấu trúc thư mục, code comments và schema cơ sở dữ liệu để tạo tài liệu kỹ thuật API hoàn chỉnh. Giúp lập trình viên tiết kiệm hàng giờ viết tài liệu và giữ tài liệu luôn cập nhật cùng mã nguồn.
Phù hợp với: Dành cho đội ngũ phát triển phần mềm muốn tự động hóa việc xuất tài liệu kỹ thuật, swagger docs và kiến trúc hệ thống.
Bình chọn nếu workflow này hữu ích
Yêu cầu kiến thức kỹ thuật, API/automation. Nên dành nửa ngày.
Video hướng dẫn
Chưa có video hướng dẫn riêng cho workflow này.
Tìm video liên quan trên YouTube Chuẩn bị trước khi bắt đầu
- Tài khoản của các AI Agent bên dưới (free tier là đủ để chạy thử).
- Một công cụ liên kết tự động: Zapier / Make.com / n8n.
- Nguồn dữ liệu đầu vào: Google Sheet, Notion, Airtable hoặc API.
- 30–60 phút thời gian setup lần đầu, sau đó workflow tự chạy.
AI Agent sử dụng
Click vào mỗi AI Agent để xem hướng dẫn, giá và link tải về.
Tag liên quan
Hướng dẫn setup chuyên sâu
1. Thiết lập Solarcompilelabs CLI trong script build dự án hoặc pipeline CI/CD.
2. Cấu hình endpoint API cho mô hình ngôn ngữ mã nguồn GPT-NeoX thông qua dịch vụ hosting riêng hoặc API provider.
3. Đăng ký Codeium Forge token để thực hiện các thao tác format code và tự động tạo commit.
4. Đảm bảo các hàm trong code có comment cơ bản chuẩn JSDoc, Docstring hoặc PHPDoc để AI hiểu ngữ cảnh tốt nhất.
5. Cấu hình file workflow chạy khi có tag release mới trên GitHub/GitLab.
6. Kiểm tra trang web tài liệu sinh ra trên Vercel hoặc GitHub Pages đảm bảo tính chính xác của schema JSON.
Hướng dẫn setup chi tiết
- 1
Thu thập cấu trúc file và endpoint
Solarcompilelabs phân tích AST (Abstract Syntax Tree) của project để lập danh sách toàn bộ controller và model.
- 2
Sinh tài liệu kỹ thuật chi tiết
GPT-NeoX tổng hợp mô tả nghiệp vụ, giải thích tham số đầu vào, mã lỗi và dữ liệu trả về.
- 3
Biên dịch thành trang web docs
Codeium Forge định dạng tài liệu thành Markdown/OpenAPI chuẩn và tự động commit vào nhánh gh-pages.
Hoàn thành tất cả các bước theo thứ tự để đảm bảo workflow chạy đúng.
Kiểm tra giới hạn miễn phí (free tier) của từng AI Agent trước khi chạy hàng loạt.
Kết quả bạn sẽ đạt được
- Tiết kiệm 60–80% thời gian xử lý lặp lại so với làm thủ công.
- Workflow tự chạy theo lịch (mỗi giờ / mỗi ngày), không cần can thiệp.
- Có thể nhân bản và tuỳ biến cho nhiều use case khác nhau.