Hôm nay chúng tôi phát hành OpenWiki, một tác nhân mã nguồn mở và CLI để tạo và duy trì tài liệu cho các cơ sở mã nguồn.
Các tác nhân viết code tốt hơn khi chúng hiểu repo mà chúng đang làm việc. Chúng cần biết logic chính nằm ở đâu, các file kết nối với nhau như thế nào, và codebase mong đợi những mẫu (pattern) nào. Tài liệu tốt cung cấp cho tác nhân bối cảnh đó, dẫn đến các thay đổi code có cơ sở hơn và ít sai sót có thể tránh được hơn.
Vấn đề là tài liệu rất khó để cập nhật. Viết tài liệu ban đầu tốn thời gian, và cập nhật chúng mỗi khi code thay đổi còn khó hơn. Trong các repo lớn với nhiều PR thường xuyên, tài liệu có thể nhanh chóng trở nên lỗi thời.
OpenWiki xử lý công việc đó một cách tự động. Nó tạo một wiki cho repo của bạn, kết nối wiki đó với tác nhân coding của bạn, và giữ cho nó được cập nhật khi code của bạn thay đổi.
Tại sao wiki dành cho tác nhân
Chúng tôi lấy cảm hứng từ các công trình hiện có xung quanh wiki codebase, bao gồm DeepWiki, AutoWiki, và khái niệm Karpathy’s LLM Wiki. Ý tưởng chung rất đơn giản. Wiki cung cấp cho con người và tác nhân một cách có cấu trúc để hiểu codebase mà không cần ép tất cả bối cảnh vào một file khổng lồ.
Điều đó quan trọng vì hầu hết các tác nhân coding đã đọc các file như AGENTS.md hoặc CLAUDE.md để lấy hướng dẫn. Những file đó rất hữu ích, nhưng chúng không phải là nơi thích hợp để lưu trữ hàng trăm trang tài liệu repo. Chúng nên chỉ cho tác nhân đến đúng bối cảnh, sau đó để tác nhân tự truy xuất những gì nó cần.
OpenWiki tuân theo mô hình đó. Nó tạo ra một wiki cho repo, sau đó cập nhật các file hướng dẫn tác nhân của bạn với một tham chiếu đến wiki đó. Từ đó, tác nhân coding của bạn có thể tự động khám phá và sử dụng tài liệu.
Bắt đầu
OpenWiki được thiết kế để dễ dàng chạy từ dòng lệnh. Cài đặt nó với NPM:
1npm install -g openwiki
sau đó chạy:
1openwiki --init
Lệnh init yêu cầu nhà cung cấp mô hình và API key, sau đó tạo tài liệu cho repo của bạn.
OpenWiki hỗ trợ cả nhà cung cấp mô hình mở và đóng, bao gồm OpenRouter, Fireworks, Baseten, OpenAI, và Anthropic. Theo mặc định, nó sử dụng OpenRouter với một mô hình mở, nhưng bạn có thể cấu hình nhà cung cấp phù hợp nhất với thiết lập của bạn.
Vì OpenWiki được xây dựng trên nền tảng DeepAgents, nó cũng hỗ trợ tracing đến LangSmith. Nếu bạn cung cấp API key LangSmith, OpenWiki sẽ trace các lần chạy đến một dự án LangSmith để bạn có thể kiểm tra chính xác những gì tác nhân đã làm trong khi tạo hoặc cập nhật tài liệu của bạn.
Cách OpenWiki kết nối với tác nhân coding của bạn
Sau khi tạo wiki, OpenWiki cập nhật các file hướng dẫn tác nhân của repo. Nếu repo của bạn sử dụng AGENTS.md, CLAUDE.md, hoặc cả hai, OpenWiki thêm một tham chiếu đến wiki đã tạo và giải thích khi nào tác nhân nên sử dụng nó.
Chúng tôi chọn cách tiếp cận này vì đặt toàn bộ wiki vào trong một file hướng dẫn sẽ thêm quá nhiều bối cảnh. Trong một repo lớn, wiki có thể bao gồm hàng trăm file. Tải tất cả những thứ đó vào mỗi lần chạy tác nhân sẽ lãng phí và khó bảo trì.
Một tham chiếu ngắn hoạt động tốt hơn. Tác nhân coding của bạn đã đọc file hướng dẫn. Khi OpenWiki thêm tham chiếu, tác nhân có thể tìm thấy wiki khi cần bối cảnh repo, mà không yêu cầu bạn thay đổi quy trình làm việc.
Giữ wiki luôn cập nhật
Tạo tài liệu một lần rất hữu ích. Giữ chúng luôn cập nhật là lúc OpenWiki trở nên giá trị hơn.
OpenWiki bao gồm một GitHub Action có thể chạy theo lịch trình, ví dụ mỗi ngày một lần. Action chạy OpenWiki với cờ update. OpenWiki kiểm tra những commit nào đã được thêm vào kể từ lần chạy cuối, sử dụng git diff để hiểu những gì đã thay đổi, sau đó cập nhật wiki với bối cảnh liên quan.
Điều đó có nghĩa là quy trình làm việc có thể chạy ngầm. Khi codebase của bạn thay đổi, OpenWiki cập nhật tài liệu. Tác nhân coding của bạn tiếp tục lấy wiki mới nhất thông qua tham chiếu file hướng dẫn hiện có.
Được xây dựng cho codebase trước tiên
Bản phát hành đầu tiên này tập trung vào wiki cho codebase. Mục tiêu là giúp các tác nhân dễ dàng hiểu các repo mà chúng làm việc, mà không yêu cầu nhà phát triển phải tự viết và duy trì tài liệu chi tiết.
Theo thời gian, chúng tôi nghĩ khái niệm OpenWiki có thể áp dụng rộng rãi hơn. Các tác nhân cần bối cảnh bền vững cho nhiều loại công việc, không chỉ coding. Tài liệu codebase là trường hợp sử dụng đầu tiên, nhưng mô hình tương tự cũng có thể giúp các tác nhân duy trì bối cảnh hữu ích trong các quy trình làm việc khác.
Dùng thử
OpenWiki là mã nguồn mở và đã có sẵn. Bạn có thể cài đặt nó, chạy openwiki --init, và tạo wiki cho repo của bạn trong vài phút.
Xem repo tại đây: https://github.com/langchain-ai/openwiki và xem video hướng dẫn: https://youtu.be/nIVu3zfYprI
