Cluedoc: Kỹ năng tác nhân viết tài liệu giúp hiểu codebase

Bạn có đang mệt mỏi vì lượng mã mà các tác nhân lập trình liên tục tạo ra không? Vì thế mà bạn đã từ bỏ việc hiểu phần mềm của mình?

Khi tác nhân viết mã, việc hiểu nó trở thành điều quan trọng nhất. Bạn không tự tay gõ lấy dù chỉ một dòng, codebase thì liên tục thay đổi, vậy làm sao biết hệ thống thực sự đang làm gì và liệu chỉnh sửa tiếp theo có an toàn hay không? Ngay cả khi tác nhân làm việc thay bạn, để dẫn dắt tác nhân đi đúng hướng, bạn vẫn cần có mức hiểu biết tối thiểu về hệ thống mình đang xây dựng.

Vì vậy chúng tôi đã tạo ra Cluedoc. Cluedoc là một Agent Skill khiến tác nhân lập trình viết ra các tài liệu mà con người dễ đọc. Tài liệu của Cluedoc được tạo ra để người ta thực sự đọc. Chúng tập trung vào các khái niệm ở mức cao, chỉ giữ lại những chi tiết kỹ thuật cần thiết.

Cluedoc nhìn hệ thống như một cây các tính năng (feature), và viết một tài liệu (paper) cho mỗi tính năng. Tài liệu tồn tại ngay trong codebase dưới dạng Markdown thuần và luôn được cập nhật mới nhất trong vòng lặp làm việc. Không cần máy chủ, cũng không cần cơ sở dữ liệu.

Chính trang landing page được liên kết cũng là một tài liệu Cluedoc viết về Cluedoc. Ngoài ra còn có các tài liệu mẫu được tạo cho Flask, Cobra và Commander, hãy thử xem qua.