BA Docs

Giao diện

Project Context — SAPP Works tools (as-built) ​

Mode ​

B – As-built

Background ​

Cụm tool nội bộ dưới /works/sapp/tools của CMS mind_keep, hỗ trợ kiểm thử và vận hành các ticket SAPP (HubSpot, eContract, SAP, SAPP Ops/LMS). Tool đã triển khai và đang chạy nhưng chưa có bộ tài liệu nghiệp vụ; tài liệu hiện có là API doc shared/api-docs/sapp.md (hợp đồng API, viết cho dev) và các trao đổi với đối tác ở shared/external/sapp/.

Objectives ​

  • Có bộ FS as-built cho từng nhóm tool + một chương nền tảng dùng chung, đủ để người mới hiểu tool làm gì, rule nào đang chạy, và làm baseline cho mọi thay đổi sau (Mode C).
  • Có BRD tóm tắt (reconstructed) mô tả mục đích từng nhóm tool.

Scope ​

  • In: 13 sub-tool trong TOOL_CODES họ sapp.* (sapp.001 → sapp.013), trang hub /works/sapp/tools, các dịch vụ dùng chung mà chúng gọi (auto-login SAPP Ops, env_systems, secret gate, SAP log trace, Ops passthrough, Ops SQL runner, lưu trạng thái tool).
  • Out: hành vi bên trong các hệ thống ngoài (HubSpot, SAP, SAPP Ops, LMS) — chỉ mô tả cách tool gọi và hiểu kết quả; tool họ naucode.*.

Hệ thống liên quan (theo ba/system-profile.md) ​

  • Thành phần bị ảnh hưởng (ID ở §1): BE, FE. (APP: không có màn SAPP — xác nhận trong inventory.)
  • Điểm vào đã biết: route fe/app/works/sapp/tools/*, component fe/src/ui/components/works/sapp/, controller be/apps/api/src/sapp/, service be/libs/modules/src/lib/sapp/, doc shared/api-docs/sapp.md.

Nhóm tài liệu ​

NhómSub-tool (TOOL_CODES)InventoryFS
Nền tảng dùng chunghub + dịch vụ chungworking/ai-drafts/feature-inventory-platform-20260930.mddocs/fs/sapp-platform-as-built-*
HubSpotsapp.001–004…-hubspot-20260930.mddocs/fs/sapp-hubspot-as-built-*
SAPP-20603 eContractsapp.005, 012, 013…-20603-econtract-20260930.mddocs/fs/sapp-20603-econtract-as-built-*
SAPP-24395sapp.006, 007…-24395-20260930.mddocs/fs/sapp-24395-as-built-*
SAPP-23954sapp.008, 009…-23954-20260930.mddocs/fs/sapp-23954-as-built-*
SAPP-26878sapp.010…-26878-20260930.mddocs/fs/sapp-26878-as-built-*
SAPP-26297sapp.011…-26297-20260930.mddocs/fs/sapp-26297-as-built-*

Stakeholders ​

  • Owner / BA: người dùng repo (Dang Ngoc Quan) — ❓ xác nhận ai là người dùng tool hằng ngày.

Key References ​

  • shared/api-docs/sapp.md, shared/external/sapp/, shared/runbooks/sapp/
  • ba/knowledge-base/sapp/ (mục lục Confluence SAPP — không tra trong dự án này, xem Decisions)