Tóm tắt nhanh / Lệnh

Bộ Engineer

/ak:docs

Tạo và audit tài liệu dự án

Tạo, làm mới, tóm tắt, audit và tối ưu tài liệu dự án cùng root agent context dựa trên bằng chứng hiện tại.

01

Chốt ý định

02

Định tuyến thao tác

03

Nạp quy tắc

04

Khám phá contract

Nguyên tắc 01

Code sở hữu WHAT và HOW; docs sở hữu WHY và WHERE.

Nguyên tắc 02

Tài liệu là lớp điều hướng mỏng, không phải bản sao danh mục code.

Nguyên tắc 03

Không giả định tên file, số lượng file hoặc layout docs phổ quát.

Nguyên tắc 04

Xóa hướng dẫn lỗi thời thay vì giữ lại cho lịch sử.

Nguyên tắc 05

Root agent context là trí nhớ quy trình, không thay thế tài liệu dự án.

Bản đồ thực thi

Các nhánh chính từ đầu vào đến kết quả, bám theo cách command chạy khi dùng thật.

01

Khởi động

Đầu vào, phạm vi, route

  1. 1 Chốt ý định Xác định người đọc, quyết định cần hỗ trợ, nguồn chứng minh, nội dung bền vững so với trạng thái, và tiêu chí chấp nhận.
  2. 2 Định tuyến thao tác Đọc thao tác init, update, summarize, agent-context, agents, llms, hoặc hỏi lại khi trống/mơ hồ.
  3. 3 Nạp quy tắc Nạp doc-content-rules khi viết tài liệu hoặc agent-context-rules khi làm CLAUDE.md/AGENTS.md.
02

Xử lý

Agent / skill thực thi

  1. 4 Khám phá contract Đọc chỉ dẫn repo, README, docs index, file docs, rồi source/test/script/artifact sinh ra/live state để chứng minh claim.
  2. 5 Tách quyền sở hữu Để code sở hữu WHAT/HOW; docs sở hữu WHY/WHERE, quyết định, phương án bị loại, business rule, thuật ngữ và ràng buộc.
  3. 6 Sửa gọn Chỉ cập nhật docs bị ảnh hưởng, xóa hướng dẫn cũ/trùng, và link đến script hoặc manifest sở hữu thay vì copy danh sách.
03

Kiểm chứng

Gate, review, xác thực

  1. 7 Xử lý agent context Với root CLAUDE.md/AGENTS.md, giữ trí nhớ quy trình dạng mệnh lệnh tách khỏi tài liệu dự án thông thường.
  2. 8 Xác minh claim Kiểm tra mọi path, lệnh, khóa cấu hình và mô tả hành vi bằng bằng chứng hiện tại trước khi bàn giao.
  3. 9 Tóm tắt thay đổi Báo cáo phần đã đổi, phần đã xóa, bằng chứng đã dùng và vật liệu tạm thời được giữ ngoài nguồn evergreen.

Cú pháp, đối số, subcommand

Cách gọi skill: cú pháp, đối số vị trí, option dùng chung, rồi từng subcommand với cú pháp và kết quả riêng.

Cú pháp

/ak:docs <init|update|summarize|agent-context|agents|llms> [request] [--advice]

Đối số

<operation> Bắt buộc

Thao tác docs

Từ đầu tiên bắt buộc: init, update, summarize, agent-context, agents hoặc llms. Input trống hoặc không rõ sẽ hỏi người dùng chọn thay vì tự giả định init.

/ak:docs update "Reconcile onboarding docs with the current authentication flow"
[request]

Yêu cầu docs

Phạm vi, hành vi đã đổi, audience, bằng chứng hoặc tiêu chí chấp nhận tùy chọn bằng ngôn ngữ tự nhiên cho thao tác đã chọn.

Option dùng chung

--advice

Cố vấn

Hỏi kongming tư vấn trước thay đổi tài liệu hoặc root context được đề xuất. Kongming chỉ cố vấn; ak:docs vẫn chịu trách nhiệm sửa và xác nhận.

/ak:docs update --advice "Reconcile onboarding docs with the current authentication flow"

Subcommand

init Khởi tạo docs
/ak:docs init [request] [--advice]

Thiết lập tuyến tài liệu nhỏ nhất dành riêng cho project. Không áp đặt cây template cố định.

[request]
Audience, kết quả, bằng chứng, điều hướng hoặc tiêu chí chấp nhận cho tuyến mới.

Kết quả: Chỉ tạo, giữ, thay thế hoặc xóa các bề mặt thẩm quyền cần cho navigation hoạt động và claim đã xác minh.

/ak:docs init
update Cập nhật docs
/ak:docs update [changed contract] [--advice]

Đối chiếu tài liệu bị ảnh hưởng với ý định và bằng chứng hiện tại. Chỉ chạm vào bề mặt thẩm quyền bị ảnh hưởng.

[changed contract]
Hành vi, kiến trúc, cấu hình hoặc hướng dẫn vận hành đã đổi và cần đối chiếu docs.

Kết quả: Diff tài liệu tối thiểu, claim đã đổi được ánh xạ tới bằng chứng và phần trùng lặp lỗi thời được xóa.

/ak:docs update "Reconcile onboarding docs with the current authentication flow"
summarize Tóm tắt bằng chứng
/ak:docs summarize [focus] [--advice]

Tạo bản tóm tắt project dựa trên bằng chứng. Không bắt buộc tạo tệp mới trừ khi được yêu cầu hoặc project đã chỉ định.

[focus]
Chủ đề, subsystem hoặc quyết định tùy chọn mà bản tóm tắt cần bao phủ.

Kết quả: Bản tóm tắt tập trung, tách hành vi hiện tại, hướng dự kiến và bằng chứng có trạng thái.

/ak:docs summarize auth flow
agent-context Root agent context
/ak:docs agent-context [--advice] [--audit]

Soạn, audit hoặc tối ưu process memory CLAUDE.md hoặc AGENTS.md ở root repo. Nội dung này tách khỏi docs project thông thường.

--audit
Lấy audit từ kongming, rồi hỏi từng quyết định keep, cut, fix hoặc migrate trước khi áp dụng thay đổi đã xác nhận.

Kết quả: Chỉ thay đổi root context đã xác nhận, loại secret và giữ setting tự động hoặc cấu hình Hook ở mức khuyến nghị.

/ak:docs agent-context --advice
agents Khai thác quy tắc agent
/ak:docs agents [bound] [--source] [--dry-run] [--audit]

Khai thác lịch sử git và CI có giới hạn để tìm lỗi lặp lại và gotcha nên trở thành quy tắc process ở root. Thao tác này mặc định có cố vấn.

[bound]
Số ngày như 30d hoặc số commit như 500 tùy chọn. Mặc định lấy giá trị nhỏ hơn giữa 90 ngày hoặc 300 commit cùng 200 CI run.
--source
Bổ sung khai thác source tree chỉ đọc bằng ak:scout để củng cố signal từ git và CI.
--dry-run
Dừng sau khi xếp hạng signal. Không khởi chạy adviser và không ghi tệp.
--audit
Hỏi từng quyết định keep, cut, fix hoặc migrate cho mỗi quy tắc được đề xuất trước khi ghi.

Kết quả: Signal đã xếp hạng và chỉ ghi quy tắc DO/DON'T root-context đã xác nhận; dry-run chỉ báo cáo và không ghi.

/ak:docs agents 30d --source
llms Index cho AI đọc
/ak:docs llms [--advice]

Tạo hoặc cập nhật llms.txt và llms-full.txt từ tuyến tài liệu đã khám phá.

Kết quả: Index hợp lệ trong thư mục public/static của site hoặc root repo, link đã xác minh và kích thước full-content được báo cáo.

/ak:docs llms

Mode / route nên dùng

init

Tạo tuyến docs

Nghiên cứu:
init-workflow
Review:
Avoid fixed layout
Xác thực:
Minimal docs route proven
update

Làm mới docs liên quan

Nghiên cứu:
update-workflow
Review:
Check stale duplicates
Xác thực:
Changed evidence reconciled
summarize

Tóm tắt bằng chứng

Nghiên cứu:
summarize-workflow
Review:
No forced new file
Xác thực:
Summary cites sources
agent-context

Root agent context

Nghiên cứu:
agent-context-rules
Review:
Keep imperative only
Xác thực:
Confirmed changes only
agents

Khai thác quy tắc lặp

Nghiên cứu:
agents-workflow
Review:
Corroborate git/CI/source
Xác thực:
Confirmed DO/DON'T rules
llms

llms.txt

Nghiên cứu:
llms.md
Review:
Check public doc shape
Xác thực:
llms files current

Tính năng đặc biệt

Giới hạn khai thác agents

agents nhận giới hạn theo ngày hoặc số commit và mặc định lấy giá trị nhỏ hơn giữa 90 ngày hoặc 300 commit cùng 200 CI run.

Chỉ vẽ khi hữu ích

Chỉ dùng skill sơ đồ khi hình ảnh thật sự giúp hiểu hơn, rồi phải xem lại kết quả bằng mắt.

Prompt mẫu

Ví dụ gọi command theo từng flag, subcommand, mode hoặc route dùng được trong workflow thực tế.

Khởi tạo docs Khuyến nghị
/ak:docs init
Dùng khi:
Project cần tuyến tài liệu mạch lạc đầu tiên mà không áp đặt cây template cố định.
Kết quả:
Xác nhận contract tài liệu, khám phá các bề mặt thẩm quyền hiện có và chỉ tạo tuyến nhỏ nhất dựa trên bằng chứng cho điều hướng cùng quyết định.
Làm mới docs với cố vấn
/ak:docs update --advice "Đối chiếu docs onboarding với luồng authentication hiện tại"
Dùng khi:
Hành vi, kiến trúc, cấu hình hoặc hướng dẫn vận hành đã đổi và docs bị ảnh hưởng cần được đối chiếu.
Kết quả:
Chạy bước kiểm tra contract có phạm vi, tính đến cố vấn kongming trước khi ghi, ánh xạ claim đã đổi tới bằng chứng hiện tại và xóa phần trùng lặp lỗi thời.
Audit root agent context
/ak:docs agent-context --audit
Dùng khi:
Root CLAUDE.md hoặc AGENTS.md cần review keep, cut, fix hoặc migrate trước khi sửa.
Kết quả:
Nạp agent-context-rules, lấy audit từ kongming, hỏi từng quyết định đã xác nhận, loại secret và chỉ áp dụng thay đổi root-context được chấp nhận.
Khai thác quy tắc có source
/ak:docs agents 30d --source
Dùng khi:
Lỗi lặp lại chỉ nên thành quy tắc process ở root khi git, CI và source marker cùng chứng minh.
Kết quả:
Khai thác lịch sử git và CI có giới hạn, bổ sung khai thác source marker chỉ đọc bằng ak:scout, áp dụng gate corroboration và chỉ ghi quy tắc DO/DON'T đã xác nhận.
Tóm tắt bằng chứng
/ak:docs summarize
Dùng khi:
Khi docs và bằng chứng nguồn hiện có cần được cô đọng mà không ép layout file mới.
Kết quả:
Đọc contract tài liệu hiện tại, trích nguồn sẵn có và chỉ ghi summary khi workflow summarize yêu cầu artifact.
Tạo llms.txt
/ak:docs llms
Dùng khi:
Khi project cần index llmstxt.org sinh từ docs hoặc code hiện tại.
Kết quả:
Quét docs hoặc codebase, ghi llms.txt theo llmstxt.org và báo path output mà không bịa thêm cây tài liệu.

Phạm vi xử lý

  • Workflow init/update/summarize tài liệu
  • Soạn, audit và tối ưu CLAUDE.md cùng AGENTS.md
  • Khai thác git/CI/source để rút quy tắc DO/DON'T lặp lại cho agent
  • Tạo llms.txt và llms-full.txt theo llmstxt.org
  • Cắt gọn tài liệu và thiết kế điều hướng dựa trên bằng chứng

Skill liên quan

Tiếp theo