Back to Details

tapd-story-sync

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

TAPD 需求同步

TAPD Requirement Sync

将本地 Markdown 需求同步到 TAPD。
Sync local Markdown requirements to TAPD.

使用场景

Usage Scenarios

  • 用户要求同步、更新、推送修改，或重新提交需求
  • Markdown 文件里已经有 
    tapd_id
  • 目标是让 TAPD 和本地 Markdown 保持一致
  • Users need to sync, update, push changes, or resubmit requirements
  • The Markdown file already contains 
    tapd_id
  • The goal is to keep TAPD and local Markdown in sync

执行步骤

Execution Steps

  1. 读取 Markdown 文件。
  2. 确认 frontmatter 中存在 
    tapd_id
    。
  3. 执行：
bash
tapd story update <markdown-file>
  1. 验证：
    • 更新执行成功
    • updated_at
      已写回本地文件
  1. Read the Markdown file.
  2. Verify that 
    tapd_id
    exists in the frontmatter.
  3. Execute:
bash
tapd story update <markdown-file>
  1. Verification:
    • The update is executed successfully
    • updated_at
      is written back to the local file

注意事项

Notes

  • 如果原来的 
    tapd_id
    在 TAPD 中不存在，CLI 会自动重新创建需求
  • 同步过程中会处理本地图片和 Mermaid 图表
  • If the original 
    tapd_id
    does not exist in TAPD, the CLI will automatically recreate the requirement
  • Local images and Mermaid diagrams are processed during synchronization