Source document
docs/knowledge/KNOWLEDGE-PUBLISHING-SPEC.md
Source version
1.0.0
Generated time
2026-07-06T14:59:18.019Z
Owner
Engineering (Enablement)
Audience
Internal
Status
Approved

Knowledge Publishing Specification — Canonical Docs → Academy

Đặc tả xuất bản (spec). Định nghĩa cách mọi tài liệu Markdown canonical được chuyển thành nội dung học (Academy lessons).
Đây là đặc tả, không phải website, không sinh lesson, không triển khai.
Repository luôn là Source of Truth. Academy là view suy dẫn (derived) — không bao giờ tự sửa nội dung.
Phiên bản: 1.0.0 · Ngày: 2026-07-06.

Nguyên tắc nền (bất biến)

  1. Repository là Source of Truth. Academy chỉ trình bày lại, không sở hữu tri thức.
  2. Academy không chỉnh sửa nội dung. Mọi sửa đổi tri thức xảy ra ở Repository, rồi Academy tái sinh.
  3. Mỗi lesson truy về đúng một tài liệu canonical. Không lesson nào không có nguồn.
  4. Không trùng lặp tri thức. Một sự thật, một nơi (kế thừa knowledge-index/06-KNOWLEDGE-LIFECYCLE).
  5. Không copy-paste thủ công. Nội dung được suy dẫn có truy vết, không chép tay.

1. Purpose — Mục đích

Chuẩn hoá cách chuyển tài liệu canonical (docs/) thành nội dung học có cấu trúc, giữ Repository là nguồn duy nhất. Đặc tả này để đội Knowledge/Enablement vận hành Academy như một lớp trình bày tái sinh được từ Repository, không phải một kho tri thức thứ hai.


2. Canonical Source Rule — Quy tắc nguồn canonical


3. Lesson Generation Rules — Quy tắc sinh lesson


4. Knowledge Card Structure — Cấu trúc thẻ tri thức

Knowledge Card = đơn vị lesson nhỏ nhất, truy về một section nguồn.

Front-matter (bắt buộc):

TrườngÝ nghĩa
card_idĐịnh danh ổn định
titleTiêu đề lesson
source_pathĐường dẫn tài liệu canonical (một nguồn)
source_versionPhiên bản nguồn tại lúc sinh (từ Change Log của nguồn)
source_sectionsAnchor(s) section nguồn được dùng
source_hashBăm nội dung nguồn (hoặc các section) — cho đồng bộ phiên bản
audienceĐối tượng (Founder / Sales / Customer …)
learning_objectivesMục tiêu học (suy ra từ nguồn)
prerequisitesCard tiên quyết (nếu có)
tagsChủ đề/segment
sync_statecurrent / stale / orphaned (mục 7)

Body: khái niệm → vì sao quan trọng → điểm chính (mỗi điểm truy về section nguồn) → kiểm tra hiểu (câu hỏi suy ra từ nguồn).

Provenance footer (bắt buộc): liên kết canonical + source_version ("Nguồn sự thật: <source_path> v<version>"). Không có provenance ⇒ card không hợp lệ, không xuất bản.


5. Learning Path Structure — Cấu trúc lộ trình học


6. Navigation Rules — Quy tắc điều hướng


7. Version Synchronization — Đồng bộ phiên bản

Cơ chế phát hiện lệch (spec, chưa triển khai):


8. Publication Workflow — Quy trình xuất bản

Quy trình suy dẫn, tái chạy được (spec, không triển khai):

  1. Chọn nguồn từ Document Map (chỉ Approved).
  2. Trích section theo quy tắc sinh (mục 3).
  3. Sinh Knowledge Card kèm front-matter + provenance (mục 4).
  4. Lắp Learning Path (mục 5) + điều hướng (mục 6).
  5. Kiểm hợp lệ: provenance đầy đủ · không tri thức mới · đúng phân tầng đối tượng.
  6. Kiểm đồng bộ phiên bản (mục 7); đánh dấu stale/orphaned.
  7. Duyệt (mục 9) → xuất bản / tái sinh.

Mọi lần chạy trên cùng nguồn + cùng phiên bản ⇒ cùng kết quả (không sáng tạo nội dung mới).


9. Review Policy — Chính sách duyệt


10. Change Log — Nhật ký thay đổi

Phiên bảnNgàyThay đổi
1.0.02026-07-06Tạo đặc tả xuất bản tri thức (canonical → Academy): quy tắc nguồn, quy tắc sinh lesson, cấu trúc Knowledge Card, Learning Path, điều hướng, đồng bộ phiên bản, quy trình xuất bản, chính sách duyệt. Kế thừa knowledge-index (lifecycle/owners/document-map/glossary). Không website, không sinh lesson, không triển khai.