AgentKit
Tài liệuBộ kitTham chiếu CLIỨng dụng Desktop

Skill

Giữ tri thức project marketing luôn cập nhật với ak:docs

Tạo, cập nhật hoặc tóm tắt route tài liệu nhỏ nhất mà project marketing cần dựa trên bằng chứng.

Dùng ak:docs để tạo, đối chiếu hoặc tóm tắt tài liệu project mà không áp đặt cây thư mục chuẩn. Skill giữ quyết định, constraint, terminology và navigation trong prose, đồng thời trỏ behavior hiện tại tới bằng chứng thực thi được.

Chọn ak:docs cho tài liệu dựa trên bằng chứng

Dùng ak:docs khi

  • Project marketing cần route tài liệu tối thiểu cho con người, AI collaborator hoặc cả hai.
  • Workflow, configuration, public contract hoặc operating constraint đã duyệt thay đổi và tài liệu gần đó có thể đã cũ.
  • Bạn cần bản tóm tắt tập trung từ bằng chứng hiện tại của project.
  • Tài liệu đang sao chép command, inventory hoặc implementation behavior dễ đổi.

Chọn workflow khác khi

  • Tầm nhìn hoặc quyết định của bạn cần trở thành tài liệu qua phỏng vấn. Dùng ak:interview-docs.
  • Bạn cần research assignment. Dùng ak:research-prompt.
  • Bạn muốn triển khai product code. ak:docs loại trừ rõ công việc đó.
  • Bạn chỉ cần sơ đồ. Dùng ak:mermaidjs-v11 hoặc ak:tech-graph.

Chuẩn bị project và runtime

Xác định audience, quyết định tài liệu phải hỗ trợ, nguồn chứng minh behavior hiện tại và acceptance criteria. Chạy từ project có instruction cùng bằng chứng sẽ chi phối kết quả.

Skill đọc instruction như AGENTS.md hoặc CLAUDE.md, README.md ở root, navigation tài liệu hiện có, tài liệu gần đó, rồi source, test, script, generated artifact và live state liên quan. Skill không giả định filename, số lượng tệp hay cây tài liệu chung.

RuntimeCách gọiRanh giới khả dụng
Claude Code/ak:docs ...Phân phối native là mặc định; plugin rõ ràng cũng được hỗ trợ.
Cursor/ak:docs ...Cách gọi bằng slash đã được người dùng xác minh; parity Agent và Hook rộng hơn chưa được thiết lập.
Codex$ak:docs ...Native Skill discovery được hỗ trợ; Hook chỉ được projection một phần và không có statusline Marketing.

Xem Runtime adapter để biết khác biệt theo từng component.

Chạy Skill

Argument đầu tiên chọn init, update, summarize, agent-context, agents hoặc llms. Input trống hay không rõ khiến Skill hỏi lại; Skill không bao giờ tự giả định init.

/ak:docs update Đối chiếu tài liệu launch với campaign workflow đã duyệt. Chỉ đổi claim được bằng chứng hiện tại của project chứng minh, giữ tài liệu không liên quan và không publish
Thao tácKết quảRanh giới mutation
initThiết lập route tài liệu nhỏ nhất riêng cho project.Có thể tạo hoặc sửa tài liệu đã duyệt; không có cây chuẩn hay placeholder.
updateChỉ đối chiếu tài liệu bị ảnh hưởng bởi intent hoặc bằng chứng đã đổi.Có thể sửa hoặc xóa prose cũ hay trùng; tài liệu hợp lệ không liên quan được giữ nguyên.
summarizeTrả về bản tóm tắt dựa trên bằng chứng.Không tạo file trừ khi project chỉ định hoặc bạn yêu cầu target lâu dài.
agent-contextAuthor, audit hoặc tối ưu process memory tại repository root.Nhắm tới CLAUDE.md của Claude Code hoặc AGENTS.md của Codex; mọi lần ghi vẫn cần xác nhận.
agentsKhai thác git và CI history có giới hạn để tìm failure lặp lại cùng gotcha không thể tự suy ra.Đề xuất tối đa năm candidate rule DO/DON'T cho root context file; chỉ ghi thay đổi đã xác nhận.
llmsTạo hoặc cập nhật docs index cho AI cùng bản companion chứa toàn bộ nội dung của project.Ghi llms.txt và llms-full.txt cạnh nhau trong thư mục public/static hoặc repository root.

Với root context, /ak:docs agent-context --advice hỏi kongming trước khi đề xuất ghi. /ak:docs agent-context --audit trình bày từng quyết định keep, cut, fix hoặc migrate và chỉ áp dụng thay đổi đã xác nhận. /ak:docs agents mặc định đã bao gồm lượt review của kongming; --advice là dư thừa. Skill mặc định khai thác giới hạn nhỏ hơn giữa 90 ngày và 300 commit, cùng tối đa 200 CI run. Nếu gh chưa được xác thực, Skill chuyển sang chỉ khai thác Git và báo rằng đã bỏ qua CI signal. --source thêm source-tree mining chỉ đọc; --dry-run dừng sau khi xếp hạng signal, không đề xuất rule, không gọi advisor và không ghi tệp; --audit xác nhận từng rule được đề xuất. /ak:docs llms đối chiếu cả llms.txt và llms-full.txt thay vì thay thế mù quáng nội dung đã tuyển chọn. Trong Codex, dùng $ak:docs. Setting và cấu hình Hook deterministic chỉ được khuyến nghị, và chưa có filename root context cho Cursor. Chỉ dùng ak:folder-context cho thư mục con.

Theo các giai đoạn dựa trên bằng chứng

  1. Xác lập contract. Giới hạn audience, outcome, authority, bằng chứng, scope và acceptance criteria.
  2. Khám phá route. Đọc instruction cùng navigation trước khi chọn tài liệu.
  3. Map claim tới owner. Dùng source, test, schema, manifest, generator và live state cho behavior hiện tại.
  4. Chọn thay đổi nhỏ nhất. Dùng lại route mạch lạc; tránh index rỗng, roadmap suy đoán và bộ ADR tự động.
  5. Viết hoặc tóm tắt. Trỏ tới executable owner thay vì sao chép behavior dễ thay đổi.
  6. Xác minh. Kiểm tra link, path, example, configuration key, command và owning script khi thực tế.

Khi tài liệu bị ảnh hưởng có nội dung về thiết lập, chạy hoặc cấu trúc test, Skill cũng áp dụng các nguyên tắc testing thực tiễn đi kèm nhưng vẫn giữ kết quả riêng cho project và dựa trên bằng chứng.

Giữ thay đổi tài liệu trong phạm vi quyền hạn

Công việc tài liệu không cấp quyền hành động bên ngoài

Tài liệu local không phê duyệt publish, thay đổi campaign hay tài khoản live, liên hệ audience, chi ngân sách, gửi data tới provider hoặc triển khai product code. Hãy phê duyệt riêng những hành động đó.

Đừng đặt credential, dữ liệu khách hàng riêng tư hoặc secret URL vào tài liệu. Giữ plan, audit, research và release evidence tách khỏi evergreen authority. Review đề xuất thay route tài liệu đã thiết lập trước khi ghi tệp.

Xác minh output và bằng chứng

Output path tùy theo thao tác: llms có cặp llms.txt và llms-full.txt cố định, còn các thao tác khác theo route của project hoặc trả về response. Một lần chạy hoàn tất nên xác định:

  • tài liệu được tạo, thay đổi, giữ lại hoặc xóa;
  • audience và quyết định mà mỗi tài liệu đã đổi phục vụ;
  • evidence owner cho từng claim hiện tại;
  • link, path, example và validator đã kiểm tra; và
  • uncertainty còn lại hay hành động vẫn cần phê duyệt.

Với summarize, hãy chờ response trừ khi bạn nêu target lâu dài. Với init, update, agent-context, agents hoặc llms, hãy kiểm tra diff và xác nhận không có product code hay tài liệu không liên quan bị thay đổi.

Khắc phục và hiểu giới hạn

Triệu chứngBước tiếp theo an toàn
Runtime không nhận diện ak:docsXác nhận target cùng scope, mở session mới, rồi làm theo Runtime không tìm thấy Skill hoặc Agent.
Skill hỏi cần dùng thao tác nàoChọn init, update, summarize, agent-context, agents hoặc llms; bổ sung audience, outcome, bằng chứng và cách lưu.
Cây đề xuất có vẻ chung chung hoặc quá lớnTrỏ tới instruction cùng navigation hiện có; yêu cầu information boundary thực sự nhỏ nhất.
Behavior hiện tại bị sao chép vào proseThay bằng pointer tới executable owner.
Summary file xuất hiện ngoài dự kiếnGiữ summary trong response trừ khi project hoặc yêu cầu của bạn chỉ định file đó.
Tệp ngoài tài liệu bị thay đổiDừng, kiểm tra diff và xem Projects, artifacts và checkpoints.

Skill chỉ có thể xác minh bằng chứng và live state truy cập được trong session hiện tại. Skill không thể biến claim thiếu hỗ trợ thành đúng hay quyết định policy publish.

Tiếp tục với Tổng quan Marketing Kit, Agent của Marketing Kit hoặc Cài đặt Kit.