3.0.0-beta.15). Tính năng có thể thay đổi trước bản stable tiếp theo.Chuyển sang stable →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.
- Bạn yêu cầu rõ việc xác lập nguyên tắc sản phẩm bền vững qua phỏng vấn tác
giả bằng
philosophy.
Chọn workflow khác khi
- Tầm nhìn của bạn cần thành README, strategy hoặc tài liệu khác qua phỏng vấn
thay vì contract nguyên tắc sản phẩm. 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:docsloại trừ rõ công việc đó. - Bạn chỉ cần sơ đồ. Dùng
ak:mermaidjs-v11hoặcak: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.
| Runtime | Cách gọi | Ranh 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,
philosophy 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/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$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ác | Kết quả | Ranh giới mutation |
|---|---|---|
init | Thiế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. |
update | Chỉ đố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. |
summarize | Trả 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-context | Author, 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; bảo trì thường xuyên trong scope được tự cấp quyền, còn thay prose hiện có, tài liệu sở hữu hoặc chỉnh sửa của bạn cần xác nhận. |
agents | Khai 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. |
philosophy | Xác lập nguyên tắc sản phẩm được tác giả xác nhận với mức thẩm quyền rõ ràng. | Chỉ khi opt-in rõ ràng; dùng bằng chứng project và local session cùng project có giới hạn; chỉ ghi diff tại destination đã duyệt. |
llms | Tạ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.
init, update và agent-context dùng chung một bậc thang write-authority:
việc bảo trì thường xuyên trong phạm vi được tự cấp quyền, và Skill chỉ xác nhận
trước khi thay thế prose hiện có, một tài liệu sở hữu, hoặc một chỉnh sửa bạn đã
đưa ra. Điều này bao gồm cả việc tự bảo trì sau công việc đã được cấp quyền
khác, kể cả khi không có source file nào thay đổi; khi không có gì bền vững thay
đổi, lần chạy không ghi gì. Với một tuyến vận hành, chẳng hạn cách lấy secret
hoặc log source nào cần đọc cho một environment, Skill giữ chi tiết tra cứu
trong operational guide riêng của project và chỉ để lại một pointer một dòng
trong tệp root context. Skill redact output quan sát được trước khi lưu giữ,
chuyển giao hoặc publish, và không bao giờ ghi credential value, tokenized URL,
account hoặc project ID, hay tên khách hàng vào tệp repo.
Xác lập nguyên tắc sản phẩm với philosophy
Opt-in rõ ràng khi bạn muốn tác giả hoặc người xây dựng sản phẩm quyết định ranh giới và ưu tiên bền vững:
/ak:docs philosophyTrong Codex, dùng $ak:docs philosophy. Việc bảo trì tài liệu thông thường
không bắt đầu phỏng vấn này hoặc đọc lịch sử local session nếu không được yêu
cầu rõ. Nó giữ nguyên tắc đã được tác giả xác nhận ngay cả khi không có lịch
sử incident hoặc implementation đã lệch; code chứng minh hành vi, không cấp
thẩm quyền đổi ý định.
Phỏng vấn dùng bằng chứng repo và mặc định 90 ngày gần nhất của local session đã xác minh thuộc cùng project, gồm các worktree đã chứng minh quan hệ. Skill lọc metadata project trước khi đọc nội dung trò chuyện và dùng thời điểm event, không dùng thời gian sửa tệp. Quyết định và sự chấp nhận của tác giả được tách khỏi đề xuất của assistant và suy luận; chỉ giữ attribution đã làm sạch, không giữ lịch sử thô, credential hay dữ liệu cá nhân. Lịch sử thiếu hoặc không được hỗ trợ là khoảng trống coverage cần báo cáo, không phải lý do bịa bằng chứng hoặc mở rộng quyền truy cập.
Bạn trả lời từng câu hỏi chưa giải quyết. Mỗi nguyên tắc được giữ lại nêu scope và hệ quả hành vi dưới dạng ranh giới bắt buộc hoặc ưu tiên định hướng, để ngỏ lựa chọn triển khai trong các ranh giới đó. Nguyên tắc đã xác nhận vẫn có hiệu lực cho tới khi tác giả duyệt thay thế; đề xuất lặp lại của assistant không tạo ra thẩm quyền đó.
Trước khi ghi, xem chính xác phần thêm, sửa, xóa và destination đã resolve của từng tệp bị ảnh hưởng. Target chuẩn của symlink trong project được preview và sửa mà không thay thế link; destination bên ngoài cần cấp quyền rõ ràng. Nếu thiếu câu trả lời hoặc phê duyệt exact-diff, kết quả chỉ là đề xuất và câu hỏi chưa giải quyết. Chỉ dùng lại phê duyệt trước đó khi target và patch còn hợp lệ; target đã đổi cần preview lại thay vì ghi đè chỉnh sửa đồng thời. Lặp lại nguyên tắc tương đương là no-op. Hướng dẫn được ghi là contract cộng tác, không chứng minh mọi runtime đều load hoặc thực thi nó.
Bằng chứng session chỉ đến từ lịch sử local mà runtime cho phép đọc. Claude Code và Codex lưu lịch sử session local mà Skill có thể xác minh và đọc; runtime khác chỉ được quét qua một reader local đã xác minh. Báo cáo nêu rõ nguồn bị thiếu, không truy cập được hoặc chưa được hỗ trợ thay vì khẳng định coverage đầy đủ.
Trước khi đề xuất destination, Skill đọc cả AGENTS.md và CLAUDE.md ở root
khi có, xác định symlink và nơi đang sở hữu nguyên tắc; Skill không mặc định
CLAUDE.md là bản chuẩn. Khi hai tệp độc lập, Skill preview cùng các nguyên tắc
chung trong cả hai và giữ instruction riêng theo runtime của từng tệp. Khi không
tệp nào tồn tại và project không khai báo owner, Skill đề xuất AGENTS.md làm
điểm vào portable mà không khẳng định mọi runtime đều tự động đọc nó. Các lần
chạy update và agent-context sau đó giữ nguyên ý nghĩa và thẩm quyền của
nguyên tắc đã xác nhận mà không bắt đầu lại phỏng vấn, và nêu xung đột hoặc dấu
hiệu bị thay thế cho tác giả thay vì âm thầm làm yếu, xóa hay nâng cấp một
nguyên tắc.
Theo các giai đoạn dựa trên bằng chứng
- Xác lập contract. Giới hạn audience, outcome, authority, bằng chứng, scope và acceptance criteria.
- Khám phá route. Đọc instruction cùng navigation trước khi chọn tài liệu.
- Map claim tới owner. Dùng source, test, schema, manifest, generator và live state cho behavior hiện tại.
- 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.
- Viết hoặc tóm tắt. Trỏ tới executable owner thay vì sao chép behavior dễ thay đổi.
- 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.
philosophy luôn giữ gate phê duyệt exact-diff; quyền bảo trì thường xuyên,
flag và tư vấn không thể bỏ qua gate đó.
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 philosophy, kết quả là ranh giới và ưu tiên đã xác nhận với quyền tự do
triển khai, attribution session đã làm sạch và khoảng trống coverage, cùng diff
tại destination đã duyệt hoặc kết quả chỉ đề xuất/no-op.
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, philosophy 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ứng | Bước tiếp theo an toàn |
|---|---|
Runtime không nhận diện ak:docs | Xá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ào | Chọn init, update, summarize, agent-context, agents, philosophy 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ớn | Trỏ 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 prose | Thay bằng pointer tới executable owner. |
| Summary file xuất hiện ngoài dự kiến | Giữ summary trong response trừ khi project hoặc yêu cầu của bạn chỉ định file đó. |
| Target philosophy đổi sau phê duyệt | Giữ chỉnh sửa đồng thời và preview lại diff bị ảnh hưởng; chỉ dùng lại phê duyệt cho target và patch không đổi. |
| Tệp ngoài tài liệu bị thay đổi | Dừ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.
Biến quyết định của stakeholder thành tài liệu với ak:interview-docs
Chạy phỏng vấn có hướng dẫn để đưa tầm nhìn và quyết định của người dùng vào README, ADR hoặc tài liệu project có cấu trúc.
Tạo sơ đồ inline có thể review với ak:mermaidjs-v11
Biến process, relationship, timeline hoặc data model thành Mermaid v11 source và chỉ render khi có tooling đã duyệt.