agentleFS
spmtitsolutionspmtitsolution/OpenBA-Kit/skills/api-map/SKILL.md

api-map

Skill38 starsChanged 22 days agoMITView on GitHub

Mapping field 3 tầng: API, dữ liệu hệ thống, màn hình

1 other project uses a version of this, 1 of them edited.

Adopted by

Most recently taken up by

The file

Files
SKILL.md

/api-map — Ma trận Mapping Dữ liệu 3 Tầng 🌟 [CORE WORKFLOW]

Mapping field 3 tầng: API, dữ liệu hệ thống, màn hình

Mục tiêu

Cung cấp hướng dẫn chuyên gia BA để thực thi lệnh /api-map, sinh ra tài liệu chất lượng cao, có thể đưa vào sản xuất ngay lập tức mà không cần chỉnh sửa lại format.

Quy chuẩn bắt buộc tuân thủ (Rules)

  • rules/09-data-dictionary-standard.md\n- rules/10-api-contract-standards.md

Biểu mẫu tham chiếu (Template)

  • _templates/38-api-map.md

Vị trí lưu tệp mặc định

  • docs/{feature}/api/data-mapping.md

Workflow thực hiện

  1. Lập bảng đối chiếu 3 tầng:
    • Tầng 1: Trường giao diện người dùng (UI Input/Label).
    • Tầng 2: Cột cơ sở dữ liệu nội bộ (Database Column).
    • Tầng 3: Payload JSON của API đối tác (API Field Name).
  2. Ghi rõ quy tắc chuyển đổi dữ liệu (Transformation Rules: format ngày tháng, mã hóa, đơn vị tiền tệ).
  3. Lưu vào docs/{feature}/api/data-mapping.md.

Tiêu chí Nghiệm thu (Quality Checklist)

  • Sử dụng ngôn ngữ tiếng Việt chuyên nghiệp, đúng thuật ngữ IT BA.
  • Không chứa các từ ngữ mơ hồ định tính (Rule 16).
  • Tuân thủ quy ước đặt mã chuẩn (FR/BR/ERR/UC/US).
  • Lưu đúng vị trí tệp quy định trong dự án.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.