Lời nhắc được thiết kế để phân tích cơ sở mã và tạo tài liệu Markdown toàn diện phù hợp với đối tượng điều hành, kỹ thuật, sản phẩm và doanh nghiệp. Nó hướng dẫn AI trích xuất mục đích, kiến trúc, thành phần chính, quy trình làm việc, tính năng sản phẩm, lĩnh vực kinh doanh và các hạn chế của hệ thống cấp cao, tạo ra tài liệu giới thiệu và khám phá phù hợp cho cả các bên liên quan về kỹ thuật và phi kỹ thuật.
# **Nhắc nhở phân tích mã và tạo tài liệu hệ thống** Bạn là chuyên gia về phân tích mã và tài liệu hệ thống. Nhiệm vụ của bạn là phân tích mã nguồn được cung cấp trong dự án/không gian làm việc này và tạo tài liệu Markdown toàn diện đóng vai trò là hướng dẫn giới thiệu cho nhiều đối tượng (điều hành, kỹ thuật, kinh doanh và sản phẩm). ## **Hướng dẫn** Phân tích mã nguồn được cung cấp và trích xuất thông tin sau, sắp xếp nó thành tài liệu Markdown có cấu trúc tốt: --- ## **1. Chế độ xem cấp điều hành: Tóm tắt điều hành** ### **Mục đích ứng dụng** - Mục tiêu chính của hệ thống này là gì? - Mục đích giải quyết vấn đề gì ở mức độ cao? ### **Cách thức hoạt động (Cấp cao)** - Mô tả quy trình tổng thể của hệ thống một cách ngắn gọn và dễ tiếp cận đối với đối tượng không chuyên về kỹ thuật. - Các bước hoặc quy trình chính mà hệ thống thực hiện là gì? ### **Quy tắc kinh doanh cấp cao** - Xác định và mô tả các quy tắc kinh doanh chính được thực hiện trong mã. - Các chính sách, ràng buộc hoặc logic kinh doanh cơ bản mà hệ thống tuân theo là gì? ### **Lợi ích chính** - Những lợi ích chính mà hệ thống này mang lại cho tổ chức hoặc người dùng là gì? --- ## **2. Chế độ xem cấp độ kỹ thuật: Tổng quan về công nghệ** ### **Kiến trúc hệ thống** - Mô tả kiến trúc tổng thể của hệ thống dựa trên phân tích mã. - Nó có tuân theo một mẫu cụ thể không (ví dụ: Monolithic, Microservices, v.v.)? - Các thành phần hoặc module chính được xác định là gì? ### **Các công nghệ được sử dụng (Ngăn xếp công nghệ)** - Liệt kê tất cả các ngôn ngữ lập trình, framework, thư viện, cơ sở dữ liệu và các công nghệ khác được sử dụng trong dự án. ### **Các luồng kỹ thuật chính** - Chi tiết hóa dữ liệu chính và các luồng thực thi trong hệ thống. - Các thành phần khác nhau tương tác với nhau như thế nào? ### **Thành phần chính** - Xác định và mô tả các thành phần hệ thống quan trọng nhất, giải thích vai trò và trách nhiệm của chúng trong kiến trúc. ### **Độ phức tạp của mã (Quan sát)** - Dựa trên phân tích của bạn, hãy đưa ra những quan sát chung về độ phức tạp của mã (ví dụ: các khu vực có cấu trúc tốt, được mô đun hóa, có độ phức tạp rõ ràng cao hơn). ### **Sơ đồ** - Tạo sơ đồ cấp cao để trực quan hóa kiến trúc và hành vi của hệ thống: - Sơ đồ thành phần (tập trung vào các module chính và sự tương tác của chúng) - Sơ đồ luồng dữ liệu (thể hiện cách thông tin di chuyển trong hệ thống) - Sơ đồ lớp (trình bày các lớp chính và mối quan hệ của chúng, nếu có) - Sơ đồ triển khai đơn giản hóa (hiển thị nơi các thành phần chạy, nếu có thể phát hiện được) - Sơ đồ cơ sở hạ tầng/triển khai đơn giản hóa (nếu chi tiết cơ sở hạ tầng rõ ràng) - **Tạo sơ đồ trên bằng cú pháp Nàng tiên cá trong tệp Markdown. Sơ đồ phải ở mức cao và không quá chi tiết.** --- ## **3. Xem sản phẩm: Tóm tắt sản phẩm** ### **Hệ thống làm gì (Chi tiết)** - Mô tả chi tiết các chức năng chính của hệ thống. - Người dùng có thể thực hiện những nhiệm vụ hoặc hành động nào? ### **Hệ thống dành cho ai (Người dùng / Khách hàng)** - Xác định đối tượng mục tiêu chính của hệ thống. - Ai là người dùng cuối hoặc khách hàng được hưởng lợi từ nó? ### **Các vấn đề nó giải quyết được (Cần giải quyết)** - Hệ thống giúp giải quyết những vấn đề cụ thể nào cho người dùng hoặc tổ chức? - Nó giải quyết những nhu cầu gì? ### **Trường hợp sử dụng / Hành trình của người dùng (Cấp cao)** - Các trường hợp sử dụng chính của hệ thống là gì? - Người dùng tương tác với hệ thống như thế nào để đạt được mục tiêu của mình? ### **Các tính năng cốt lõi** - Liệt kê các tính năng quan trọng nhất của hệ thống một cách rõ ràng và chính xác. ### **Miền doanh nghiệp** - Xác định các lĩnh vực kinh doanh chính được hệ thống bao phủ (ví dụ: bán hàng, hàng tồn kho, tài chính). --- ## **Giới hạn phân tích** - Những hạn chế chính gặp phải trong quá trình phân tích mã là gì? - Mô tả ngắn gọn những gì hạn chế sự hiểu biết của bạn về mã. - Đưa ra các đề xuất nhằm giảm bớt hoặc loại bỏ những hạn chế này. --- ## **Hướng dẫn về tài liệu** ### **Định dạng tài liệu** - Tài liệu phải được định dạng bằng Markdown, có tiêu đề và phụ đề rõ ràng cho từng phần. - Sử dụng danh sách, bảng và các phần tử Markdown khác để cải thiện khả năng đọc và hiểu. ### **Hướng dẫn bổ sung** - Tập trung vào việc cung cấp thông tin cấp cao, phù hợp, tránh sử dụng quá nhiều chi tiết triển khai trừ khi cần thiết để hiểu. - Sử dụng ngôn ngữ rõ ràng, ngắn gọn, dễ tiếp cận, phù hợp với nhiều đối tượng. - Càng cụ thể càng tốt dựa trên phân tích mã. - Tạo phản hồi hoàn chỉnh dưới dạng **tài liệu Markdown (`.md`) được định dạng đúng**. - Sử dụng **ngôn ngữ rõ ràng và trực tiếp**. - Sử dụng **tiêu đề và tiêu đề phụ** theo các phần trên. ### **Tiêu đề tài liệu** **Phân tích điều hành và kinh doanh của ứng dụng – "<application-name>"** ### **Tóm tắt tài liệu** Tài liệu này là kết quả phân tích mã nguồn của hệ thống <system-name> và bao gồm các lĩnh vực sau: - **Chế độ xem cấp điều hành:** Tóm tắt mục đích của ứng dụng, hoạt động cấp cao, các quy tắc kinh doanh chính và các lợi ích chính. - **Chế độ xem cấp độ kỹ thuật:** Chi tiết về kiến trúc hệ thống, công nghệ được sử dụng, luồng chính, thành phần chính và sơ đồ (thành phần, luồng dữ liệu, lớp và hoạt động triển khai). - **Chế độ xem sản phẩm:** Mô tả chi tiết về chức năng hệ thống, người dùng mục tiêu, vấn đề được giải quyết, trường hợp sử dụng chính, tính năng và lĩnh vực kinh doanh. - **Hạn chế phân tích:** Xác định các hạn chế chính trong phân tích và đề xuất để khắc phục chúng. Việc phân tích dựa trên các tệp mã nguồn có sẵn. --- ## **QUAN TRỌNG** Việc phân tích phải xem xét **TẤT CẢ các tệp dự án**. Đọc và hiểu **tất cả các tệp cần thiết** cần thiết để thực hiện nhiệm vụ và đạt được sự hiểu biết đầy đủ về hệ thống. --- ## **Hành động** Vui lòng phân tích mã nguồn hiện có trong môi trường/không gian làm việc của tôi và tạo tài liệu Markdown được yêu cầu. Tên tệp đầu ra phải tuân theo định dạng sau: `<yyyy-mm-dd-project-name-app-discovery_cursor.md>`