Credit Genie tối ưu hóa tài liệu mã nguồn với OpenWiki: Tự động hóa và cập nhật liên tục

Credit Genie là một nền tảng sức khỏe tài chính ưu tiên di động (mobile-first), được thiết kế để giúp các cá nhân làm chủ tương lai tài chính của mình. Các đội ngũ Kỹ thuật AI và ML của họ sử dụng OpenWiki, một tác nhân tài liệu kho lưu trữ mã nguồn mở của LangChain, để xây dựng một cổng thông tin tự phục vụ, giúp tổng hợp tài liệu thành một giao diện duy nhất, có thể tìm kiếm và dễ đọc đối với con người.

Credit Genie biến tài liệu thành một hệ thống sống động với OpenWiki

Khi các đội ngũ Kỹ thuật AI và ML của Credit Genie mở rộng quy mô trên một cơ sở mã nguồn ngày càng lớn, việc giữ cho tài liệu luôn cập nhật trở nên khó khăn hơn bao giờ hết. Kiến thức về các dự án riêng lẻ bắt đầu bị cô lập với những người đóng góp, và các "kiến thức truyền miệng" (tribal knowledge) bắt đầu hình thành.

Những nỗ lực nhằm chính thức hóa các quy trình tài liệu thủ công đều không đạt hiệu quả, vì việc viết và duy trì tài liệu tốt làm mất thời gian cho các công việc cấp bách khác. Đối với các đội ngũ bận rộn, tài liệu trở thành một hoạt động có tỷ lệ thay đổi cao, đòi hỏi sự bảo trì liên tục.

Để giải quyết vấn đề này, Credit Genie đã áp dụng OpenWiki của LangChain để tự động hóa hoàn toàn việc tạo và duy trì tài liệu kho lưu trữ chất lượng cao, giúp cả con người và các tác nhân lập trình (coding agents) dễ dàng tìm thấy thông tin họ cần.

Thách thức: tài liệu lỗi thời và kiến thức truyền miệng

Trước khi có OpenWiki, đội ngũ đã duy trì các trang Notion, tệp README và tệp AGENTS.md dành riêng cho từng dự án. Tuy nhiên, trong môi trường phát triển nhanh chóng của Credit Genie, nội dung đó nhanh chóng trở nên lỗi thời.

Tài liệu không chỉ trở nên cũ kỹ. Chúng còn khó tìm kiếm – và không chỉ đối với con người. Các tác nhân lập trình làm việc trên cơ sở mã nguồn cũng gặp phải vấn đề tương tự: nếu không có một nguồn thông tin đáng tin cậy, chúng khó có thể hiểu được một kho lưu trữ làm gì hoặc một hệ thống con hoạt động ra sao, và thường xuyên hành động dựa trên bối cảnh lỗi thời hoặc không đầy đủ.

Đội ngũ nhận ra rằng kiến thức quan trọng đang ngày càng tập trung vào các cá nhân. Câu trả lời cho các câu hỏi về việc một kho lưu trữ làm gì, một tính năng nằm ở đâu, hoặc một hệ thống con cụ thể hoạt động như thế nào thường rất chậm để tìm thấy và đôi khi khó tiếp cận – bất kể người hỏi là đồng nghiệp hay một tác nhân lập trình.

Giải pháp: tài liệu cấp kho lưu trữ với cổng thông tin hướng tới người dùng

Những gì ban đầu chỉ là một dự án phụ của Mattia Ciollaro, Trưởng bộ phận AI và ML tại Credit Genie, đã phát triển thành một "chính sách bảo hiểm kiến thức tổ chức" cho các đội ngũ của ông.

Mattia đã tùy chỉnh OpenWiki để xây dựng một cổng thông tin tự phục vụ được lưu trữ trên GitHub Pages, giúp tổng hợp các tài liệu OpenWiki từ tất cả các kho lưu trữ đã được tích hợp vào một giao diện web duy nhất có thể tìm kiếm. Kết quả là một hệ thống không chỉ cung cấp cho đội ngũ của ông một nguồn bối cảnh đáng tin cậy hàng ngày, mà còn giúp các tác nhân lập trình hoạt động hiệu quả hơn bằng cách hiển thị thông tin chính xác nhanh hơn, giảm bớt việc phỏng đoán và giữ cho quá trình triển khai luôn bám sát nguồn thông tin gốc: chính là mã nguồn.

Hệ thống phục vụ hai đối tượng:

Tài liệu nằm bên trong mỗi kho lưu trữ dự án trong thư mục openwiki/. OpenWiki chạy hàng đêm, kiểm tra các thay đổi commit và tạo các bản cập nhật tài liệu khi phát hiện những khác biệt đáng kể, đồng thời mở một pull request trong kho lưu trữ. Việc tích hợp một kho lưu trữ mới chỉ yêu cầu một thay đổi trong cấu hình cổng thông tin, điều này sẽ kích hoạt một pull request tự động để thêm phiên bản tùy chỉnh của quy trình làm việc GitHub Actions của OpenWiki vào kho lưu trữ mục tiêu.

Để loại bỏ các nút thắt trong việc hợp nhất (merge), Credit Genie đã thêm một hành động để tự động phê duyệt và hợp nhất các PR cập nhật của OpenWiki, loại bỏ sự ma sát từ con người trong quy trình bảo trì tài liệu. Một công việc quét chạy hàng ngày trên tất cả các kho lưu trữ đã tích hợp, hợp nhất các bản cập nhật OpenWiki đang chờ xử lý và xây dựng lại cổng thông tin để nội dung mới nhất luôn sẵn sàng.

Điều này mang lại cho Mattia và các đội ngũ của ông một cách đơn giản, có thể mở rộng để biến tài liệu thành một phần của vòng đời phát triển thay vì là một gánh nặng bảo trì riêng biệt.

"OpenWiki cho phép chúng tôi biến tài liệu thành một phần của vòng đời mã nguồn, thay vì coi nó như một công việc vặt riêng biệt," Mattia cho biết.

Cách các đội ngũ sử dụng nó

OpenWiki được sử dụng theo hai cách riêng biệt tại Credit Genie:

Như Mattia đã mô tả: "Để theo dõi sự phát triển liên tục của các hệ thống, các kỹ sư và các bên liên quan không thuộc bộ phận kỹ thuật hiện nay đều kiểm tra cổng thông tin OpenWiki. Thông thường, điều này loại bỏ nhu cầu phải đọc một lượng lớn mã nguồn vốn tốn nhiều công sức, hoặc phải tìm kiếm và phỏng vấn bất kỳ ai là 'chuyên gia', vốn tốn thời gian và sự phối hợp. Tài liệu chất lượng cao, tự động tạo và luôn cập nhật sẽ loại bỏ cả hai trở ngại đó và cho phép mọi người tìm hiểu cách hệ thống của chúng tôi hoạt động bất cứ khi nào cần."

Tác động ban đầu

Các đội ngũ của Mattia đã thấy được sự áp dụng mạnh mẽ và giá trị thực tiễn. Những lợi ích lớn nhất cho đến nay bao gồm:

Bước tiếp theo: nhận thức xuyên suốt các kho lưu trữ

Mục tiêu tiếp theo của Credit Genie là làm cho OpenWiki trở nên thông minh hơn nữa bằng cách kết hợp biểu đồ kiến thức xuyên kho lưu trữ nội bộ và dần dần tích hợp tất cả các đội ngũ kỹ thuật và kho lưu trữ mã nguồn của Credit Genie.

"Ian Yoder và Anela Trakic từ đội ngũ Web, cùng với Patrick VanDusen từ đội ngũ Ứng dụng, đã giúp chúng tôi hiểu rằng chúng tôi có thể mở rộng quy mô hệ thống. Họ đã thêm một số kho lưu trữ của đội ngũ mình và xác minh tính chính xác của các tài liệu được tạo ra. AI khiến mọi người hào hứng và tạo ra những cơ hội tuyệt vời để cộng tác giữa các phòng ban," Mattia nói thêm.

Đây là một nỗ lực chung với Adil Hashem, Trưởng bộ phận Kỹ thuật của Credit Genie, và các đội ngũ kỹ thuật đang xây dựng các công cụ AI nội bộ – bao gồm các cổng LLM, CLI tùy chỉnh và các biểu đồ mã nguồn GraphRAG.

Ngày nay, các đội ngũ kỹ thuật của Credit Genie đã lập bản đồ cách các kho lưu trữ và dự án phụ thuộc lẫn nhau. Giai đoạn tiếp theo là đưa biểu đồ đó vào OpenWiki để tài liệu không chỉ hiển thị kho lưu trữ làm gì, mà còn cho thấy cách nó kết nối với các hệ thống khác và cách các thay đổi có thể lan tỏa qua chúng. Điều này sẽ cung cấp cho tất cả các kỹ sư và tác nhân lập trình tại Credit Genie cái nhìn rõ ràng hơn về phạm vi ảnh hưởng (blast radius) trước khi thực hiện các thay đổi mã nguồn.

Trải nghiệm OpenWiki

Bạn muốn có tài liệu luôn cập nhật theo mã nguồn của mình? Hãy thử OpenWiki và thiết lập nó trên các kho lưu trữ của riêng bạn.