Smart Search Platform - Documentation Index
SharedShared Capabilities845 words4 min read
Mục tiêu
Phần tiêu đề “Mục tiêu”- Làm cửa vào duy nhất cho toàn bộ tài liệu Smart Search.
- Giúp người đọc đa vai trò (PM, Designer, Content, QA, Engineer) đọc đúng tài liệu trong ít bước nhất.
- Giảm tình trạng đọc nhầm tài liệu kỹ thuật khi chỉ cần hiểu luồng tổng quan.
Cấu trúc folder
Phần tiêu đề “Cấu trúc folder”SSP_*.mdở root: tài liệu lõi và điểm vào chung.contracts/: hợp đồng dữ liệu, taxonomy, runtime logic.ux-patterns/: hành vi theo area/page, placeholder, AI keyword map.area-bundles/: bundle tác vụ theo domain (Course, Learning, Vocabulary, Program/Course discovery).governance/: rollout, tối ưu dài hạn, completion plan.
Đọc nhanh theo vai trò
Phần tiêu đề “Đọc nhanh theo vai trò”Nếu bạn mới tham gia dự án
Phần tiêu đề “Nếu bạn mới tham gia dự án”SSP_Smart_Search_Logic_Explainer.mdSSP_00_Overview.mdSSP_Master_Product_Spec.md(chỉ đọc mục goal, lifecycle, module behavior)
Nếu bạn làm Product/UX
Phần tiêu đề “Nếu bạn làm Product/UX”SSP_Smart_Search_Logic_Explainer.mdux-patterns/SSP_Area_Positioning_Page_Behavior.mdux-patterns/SSP_UI_Placeholder_By_Flow.mdux-patterns/SSP_AI_Keyword_Widget_Map.mdcontracts/SSP_Search_Action_Feature_Traceability_Matrix.md(khi cần truy ngược card label UI -> action ID -> canonical intent)area-bundles/SSP_Course_Search_Feature_Bundles.md(khi làm flow quản lý khóa học)area-bundles/SSP_Learning_Search_Feature_Bundles.md(khi làm flow quản lý luyện tập)area-bundles/SSP_Vocabulary_Search_Feature_Bundles.md(khi làm flow sổ từ vựng)area-bundles/SSP_Program_Course_Discovery_Search_Bundles.md(khi làm flow guest/pre-login khám phá chương trình và khóa học)governance/SSP_Optimization_Framework.md(khi cần chuẩn tối ưu dài hạn, dùng chung mọi hoàn cảnh)
Nếu bạn làm Engineering/QA
Phần tiêu đề “Nếu bạn làm Engineering/QA”SSP_Master_Product_Spec.mdcontracts/SSP_Context_Pack_Adapter_Contracts.mdcontracts/SSP_Intent_Taxonomy_Result_Contract.mdcontracts/SSP_Search_Action_Feature_Traceability_Matrix.mdcontracts/SSP_Implementation_Logic_Contract.mdgovernance/SSP_Rollout_Governance.mdgovernance/SSP_Optimization_Framework.md
Bản đồ tài liệu (độ khó tăng dần)
Phần tiêu đề “Bản đồ tài liệu (độ khó tăng dần)”| Tài liệu | Dành cho ai | Mục đích chính | Độ kỹ thuật |
|---|---|---|---|
SSP_Smart_Search_Logic_Explainer.md | Tất cả | Hiểu Smart Search trong 5-10 phút | Thấp |
SSP_00_Overview.md | PM/UX/Lead | Hiểu scope và kiến trúc khái quát | Thấp-Trung bình |
SSP_Master_Product_Spec.md | PM/UX/Eng | Nguồn chuẩn tổng thể end-to-end | Trung bình |
ux-patterns/SSP_Area_Positioning_Page_Behavior.md | PM/UX/Eng | Logic theo area và page | Trung bình |
ux-patterns/SSP_UI_Placeholder_By_Flow.md | UX/Content/UI | Chuẩn placeholder/chips/states | Thấp-Trung bình |
ux-patterns/SSP_AI_Keyword_Widget_Map.md | UX/AI/Eng | Map keyword -> widget -> CTA | Trung bình |
contracts/SSP_Search_Action_Feature_Traceability_Matrix.md | PM/UX/Eng/QA | Truy ngược card label UI -> legacy action -> canonical mapping | Trung bình-Cao |
area-bundles/SSP_Course_Search_Feature_Bundles.md | PM/UX/Eng (CM) | Bundle tác vụ search riêng cho Course Management | Trung bình |
area-bundles/SSP_Learning_Search_Feature_Bundles.md | PM/UX/Eng (LM) | Bundle tác vụ search riêng cho Learning Management | Trung bình |
area-bundles/SSP_Vocabulary_Search_Feature_Bundles.md | PM/UX/Eng (VOC) | Bundle tính năng search riêng cho sổ từ vựng | Trung bình |
area-bundles/SSP_Program_Course_Discovery_Search_Bundles.md | PM/UX/Eng (Home/CM Guest) | Bundle search cho giới thiệu/chuyển đổi chương trình và khóa học | Trung bình |
governance/SSP_Optimization_Framework.md | PM/UX/Eng/Lead | Khung tối ưu dài hạn cho query/ranking/AI/handoff/telemetry | Trung bình-Cao |
ux-patterns/SSP_AI_Innovation_By_Area.md | Product/AI | Feature AI mới (proposed) | Trung bình |
contracts/SSP_Context_Pack_Adapter_Contracts.md | Eng/QA | Input context + adapter contracts | Cao |
contracts/SSP_Intent_Taxonomy_Result_Contract.md | Eng/QA | Taxonomy + result contract | Cao |
contracts/SSP_Implementation_Logic_Contract.md | Eng/QA | Logic runtime để triển khai | Cao |
governance/SSP_Rollout_Governance.md | PM/Lead | Rollout, telemetry, governance | Trung bình |
governance/SSP_Deep_Dive_and_Completion_Plan.md | PM/Lead | Gap analysis và completion plan | Trung bình |
Quy tắc đọc để tránh rối
Phần tiêu đề “Quy tắc đọc để tránh rối”- Nếu chỉ cần hiểu “Smart Search là gì”: đọc
Explainertrước, không vào contract ngay. - Nếu cần chỉnh microcopy/placeholder: đọc
Area Behavior+UI Placeholdertrước. - Nếu cần build logic runtime: đọc
Masterrồi mới sangImplementation Contract. - Không xem
AI Innovationnhư contract production; đây là lớp đề xuất.
Quy tắc cập nhật để giữ thống nhất
Phần tiêu đề “Quy tắc cập nhật để giữ thống nhất”- Mọi thay đổi logic chung phải cập nhật trước ở
SSP_Master_Product_Spec.md. - Mọi thay đổi theo area/page phải cập nhật ở
ux-patterns/SSP_Area_Positioning_Page_Behavior.md. - Mọi thay đổi placeholder/chips phải cập nhật ở
ux-patterns/SSP_UI_Placeholder_By_Flow.md. - Mọi intent mới chỉ được thêm sau governance review.
Change log
Phần tiêu đề “Change log”- 2026-02-28: Tạo index trung tâm cho Smart Search Platform để chuẩn hóa đường đọc theo vai trò.
- 2026-02-28: Tách tài liệu thành các nhóm folder
contracts,ux-patterns,area-bundles,governanceđể giảm rối và tăng khả năng mở rộng.