本文へ移動
ドキュメントを探す

Markdown

9 種類の文書は、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.

解析後のペイロードは次のとおりです。

{
  metadata: ArtifactMetadata
  body: string
}

type、schema_version、id、title、owners は必須です。 ID は空白文字を含まない空でない文字列です。owners は埋め込まれたユーザープロフィールではなく、識別子です。

任意の構造化メタデータには次を含められます。

  • description、summary、status、scope、tags
  • deciders、questions、タイムスタンプ
  • research、prds、specs、vision_targets などの型付き関係配列
  • 一般的な references、supersedes、superseded_by
  • external のプロバイダー識別情報

langdrift 内の未知のフィールドは拒否されます。 langdrift 名前空間外のルートレベル YAML はプロトコルメタデータではなく、parseArtifact は無視します。

パーサーの規則

任意の UTF-8 バイトオーダーマークを除き、ファイルはフロントマターの区切りで始まる必要があります。 パーサーは不正な YAML、カスタムタグ、重複キー、エイリアス、スキーマに合わないメタデータを拒否します。

本文は終了区切りの直後から始まります。 Unicode と元の改行コードは保持され、本文のテキストは実行されません。 見出し、文章、ファイル名から識別情報を取得したり、不足するメタデータを補ったりしません。 関係も、構造化メタデータからのみ取得します。

Record と Drift Event のエンベロープは、この Markdown ラッパーを使いません。 JSON から直接検証されます。

GitHub でこのページを編集