Chuyển đến nội dung
Duyệt tài liệu

Markdown

Chín nhóm tài liệu dùng một không gian tên trong phần đầu YAML:

---
langdrift:
  type: prd
  schema_version: 1
  id: PRD-001
  title: Product Vision dashboard
  owners: [user_42]
  research: [RES-002]
  vision_targets: [VT-001]
---
 
# Product Vision dashboard
 
Rich Markdown context remains in the body.

Dữ liệu sau khi phân tích là:

{
  metadata: ArtifactMetadata
  body: string
}

type, schema_version, id, title và owners là bắt buộc. ID là chuỗi không rỗng, không chứa khoảng trắng; chủ sở hữu là định danh, không phải hồ sơ người dùng được nhúng.

Siêu dữ liệu có cấu trúc tùy chọn gồm:

  • description, summary, status, scope và tags
  • deciders, questions và dấu thời gian
  • mảng quan hệ có kiểu như research, prds, specs và vision_targets
  • references, supersedes và superseded_by tổng quát
  • định danh nhà cung cấp external

Trường không xác định trong langdrift bị từ chối. YAML ở cấp gốc bên ngoài không gian tên langdrift không phải siêu dữ liệu giao thức và bị parseArtifact bỏ qua.

Quy tắc phân tích

Dấu phân cách phần đầu tài liệu phải nằm ở đầu tệp, ngoại trừ dấu thứ tự byte UTF-8 tùy chọn. Trình phân tích từ chối YAML sai định dạng, thẻ tùy chỉnh, khóa trùng lặp, bí danh và siêu dữ liệu không hợp lệ theo lược đồ.

Nội dung bắt đầu ngay sau dấu phân cách đóng. Unicode và kiểu xuống dòng ban đầu được giữ nguyên, và văn bản nội dung không được thực thi. Tiêu đề, văn xuôi và tên tệp không cung cấp định danh hay bổ sung siêu dữ liệu còn thiếu. Quan hệ cũng chỉ được lấy từ siêu dữ liệu có cấu trúc.

Vỏ bọc Record và Drift Event không dùng lớp Markdown này. Chúng được kiểm tra trực tiếp từ JSON.

Chỉnh sửa trang này trên GitHub