Prompt guidance: distinguish `[STATUS]` lines from `TaskCreate`/`TaskUpdate` calls

Đang mở Phù hợp với người mới
#588 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
72/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
typescript

Hướng nghiên cứu

Bắt đầu bằng cách so sánh hướng dẫn dùng chung về danh sách tác vụ trong wizard/src/lib/agent/commandments.ts với các phần Task list và Status trong context-mill/llm-prompts/basic-integration/1.0-begin.md và context-mill/transformation-config/skills/audit/description.md. Thêm một đoạn văn có thể tái sử dụng, phân biệt rõ các giai đoạn tác vụ lâu dài với hoạt động [STATUS] tạm thời, đồng thời ghi rõ khi nào sử dụng một trong hai, cả hai hoặc không sử dụng mục nào.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

wizard-pain

Problem

Agent prompts use two progress mechanisms — [STATUS] lines and the TaskCreate/TaskUpdate task list — but when to use which isn't documented in one place. basic-integration uses both; audit deliberately uses [STATUS] + the audit ledger and forbids task calls (audit/description.md: "Do not call TaskCreate / TaskUpdate / TaskGet / TaskList"). We should document the distinction and ship one reusable blurb.

When to use which

TaskCreate / TaskUpdate — the task list (durable plan).
Use when the work has distinct stages the user should follow as a plan with lifecycle. Create the list up front in a single TaskCreate (don't wait for a perfect plan), refine with further TaskCreate/TaskUpdate as understanding sharpens, and drive it with TaskUpdate: in_progress on start, completed on finish. Titles broad and job-oriented — not file/path/symbol specific.

[STATUS] — the live banner (transient activity).
Use for moment-to-moment "Working on …" narration within a stage. Emit a plain-text line prefixed [STATUS] before each phase/sub-step. Cheap, ephemeral, no lifecycle — the harness intercepts it and updates the spinner.

One or both:

  • Multi-stage flow with a task pane → use the task list for the stage backbone and [STATUS] for sub-step narration (basic-integration).
  • Flow whose progress is already tracked another way (e.g. a ledger) → skip task calls entirely, use [STATUS] only (audit).
  • Trivial/single-step work → neither.

Transportable blurb

## Task list

As soon as you have a rough sense of the work, **call `TaskCreate` immediately** — before reading any reference file or starting analysis — so the task pane isn't empty. It's fine if the first list is incomplete: seed it with the high-level items you can infer, then call `TaskCreate` again (or `TaskUpdate` to refine existing items) every time your understanding sharpens. Use `TaskUpdate` to mark an item `in_progress` when you start it and `completed` when you finish. Keeping the list current matters more than getting it right on the first call.

Keep task titles broad and job-oriented — describe the purpose or area of work (e.g. "Planning the migration", "Wiring up auth", "Writing tests"), not the specific files, paths, or symbols involved. Adjust the names to the user's project and context.

## Status

Before beginning each phase or sub-step, emit a plain-text line with the exact prefix `[STATUS]`:

[STATUS] Checking project structure

The harness intercepts these and updates the "Working on …" banner. Use them freely — they are cheap. Use `[STATUS]` for transient activity; use the task list for the durable plan of stages. If progress is already visible through another mechanism (a ledger, etc.), skip the task list and use `[STATUS]` only.

Source references

  • wizard/src/lib/agent/commandments.ts — the shared task-list commandment
  • context-mill/llm-prompts/basic-integration/1.0-begin.md — "Task list" + "Status" sections (uses both)
  • context-mill/transformation-config/skills/audit/description.md — "Live activity — [STATUS]" (uses [STATUS] + ledger, no task calls)
Ngôn ngữ chính
TypeScript
Star
204
Fork
54
Merge trung bình
1 ngày 5 giờ
Pull request đã merge (30 ngày)
51

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của PostHog/wizard

Tất cả issue của PostHog/wizard

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.