Stenography

Tạo bình luận tiếng Nhật dễ đọc chỉ bằng cách dán mã

Tốc ký là một công cụ hỗ trợ tài liệu mã cho phép AI giải mã nội dung xử lý và tự động tạo các nhận xét giải thích bằng ngôn ngữ tự nhiên chỉ bằng cách dán một hàm hoặc lớp. Được phát triển bởi Đại sứ nhà phát triển OpenAI Bram Adams, nó sử dụng kiến ​​trúc API thông qua để truyền mã mà không lưu trữ, giúp dễ dàng xử lý mã công ty. Nó hỗ trợ tạo ra các nhận xét bằng tiếng Nhật ngoài tiếng Anh, làm cho nó phù hợp với các nhóm phát triển B2B đang gặp khó khăn khi thiếu tài liệu, chẳng hạn như đọc mã kế thừa, giới thiệu thành viên mới và chuẩn bị đóng góp cho mã nguồn mở.

Các tính năng chính

Tự động tạo nhận xét: Tạo lời giải thích tương đương với chuỗi tài liệu tiếng Nhật/tiếng Anh cho từng chức năng trong vài chục giây. Việc ghi chép thủ công thường mất 15-30 phút sẽ giảm xuống còn chưa đầy một phút.

Tích hợp trình chỉnh sửa: Cung cấp tiện ích mở rộng VS Code, CLI và REST API. Nó có thể được tích hợp vào quy trình CI/CD và quy trình soạn thảo hiện có, đồng thời cũng có thể được áp dụng để hoàn thành nhận xét tự động trong quá trình PR đánh giá mã.

Hỗ trợ đa ngôn ngữ: Hỗ trợ các ngôn ngữ chính như Python, JavaScript, TypeScript, Go và Rust. Ngôn ngữ đầu ra có thể được chọn giữa tiếng Nhật và tiếng Anh và có thể được vận hành ở định dạng thống nhất ngay cả trong hệ thống phát triển toàn cầu.

Thiết kế truyền qua: Mã đầu vào không được lưu lại trên máy chủ và bị loại bỏ sau khi xử lý, giảm bớt những lo ngại về bảo mật khi làm việc với mã nội bộ.

Biên bản xác minh của ban biên tập

Do so sánh các gói giá đã công bố, tài liệu API và các công cụ tạo tài liệu của các công ty khác (Mintlify, Swimm, GitHub Copilot), quan điểm của Stenography rõ ràng là nó chuyên về "tạo nhận xét độc lập". Trong khi Copilot tập trung vào việc hoàn thiện mã và Swimm mạnh về tự động hóa tài liệu trên cơ sở kho lưu trữ, thì điểm khác biệt của Stenography là thiết kế chi phí thấp có thể được sử dụng để sử dụng tại chỗ trên cơ sở từng chức năng. Đối với ROI dự kiến, người ta ước tính rằng việc ghi lại 200 chức năng của mã kế thừa theo cách thủ công (20 phút cho mỗi chức năng) sẽ mất khoảng 66 giờ, nhưng việc sử dụng Tốc ký có thể giảm thời gian xuống còn khoảng 3-5 giờ, điều này sẽ giúp tiết kiệm khoảng 200.000 đến 300.000 yên Nhật trong giờ công của kỹ sư.

Người dùng dự định

Nó phù hợp cho các nhóm phát triển Web/SaaS có kho lưu trữ cỡ trung bình đã bước vào giai đoạn bảo trì, các công ty khởi nghiệp chưa phát triển văn hóa tài liệu và các nhà phát triển cá nhân muốn tăng cường đóng góp mã nguồn mở của họ. Mặt khác, trong trường hợp bạn muốn tự động xây dựng một trang tài liệu có hệ thống cho toàn bộ kho lưu trữ hoặc khi bạn mong đợi các tài liệu dài bao gồm các khái niệm thiết kế, các công cụ từ danh mục khác như Swimm hoặc Mintlify sẽ phù hợp.

Một công cụ tạo tài liệu AI giúp chuyển đổi nội dung xử lý của các hàm và lớp thành các nhận xét tự nhiên chỉ bằng cách dán mã. Các tiện ích mở rộng và API của trình chỉnh sửa như Mã VS đều có sẵn và thiết kế này dễ dàng kết hợp vào quy trình công việc hiện có. Việc nó hỗ trợ tạo nhận xét bằng tiếng Nhật là điều thiết thực đối với các nhóm trong nước và hữu ích cho việc giải mã mã kế thừa cũng như chuẩn bị trước khi đánh giá mã. Tuy nhiên, chất lượng đầu ra của tiếng Nhật thấp hơn một chút so với tiếng Anh và có trường hợp việc dịch thuật ngữ kỹ thuật trở nên thiếu tự nhiên. Gói miễn phí có giới hạn về số lần có thể được tạo và hoạt động trên quy mô đầy đủ yêu cầu chuyển sang gói trả phí. Lý tưởng cho các nhóm phát triển quy mô trung bình hoặc lớn hơn chú trọng đến khả năng bảo trì và cho các địa điểm nơi tài liệu có xu hướng bị trì hoãn.