Tóm tắt nhanh / Lệnh

Bộ Engineer

/ak:llms

Trình tạo llms.txt

Tạo llms.txt, llms-full.txt tùy chọn và contract bản .md cho từng trang từ thư mục docs, file hoặc URL tài liệu, theo cấu trúc llmstxt.org với section, link và bước validate súc tích.

01

Chọn nguồn

02

Tìm tài liệu

03

Rút metadata

04

Sinh index

Nguyên tắc 01

Theo cấu trúc llmstxt.org thay vì tự bịa sitemap riêng.

Nguyên tắc 02

Giữ mô tả ngắn gọn và hữu ích cho việc chọn ngữ cảnh.

Nguyên tắc 03

Tạo llms.txt, llms-full.txt và định nghĩa contract bản .md; việc phục vụ các file đó là của skill framework.

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ọn nguồn Không có tham số thì dò tài liệu từ README gốc, config site và navigation; có path thì scan thư mục hoặc file đó; có URL thì lấy cấu trúc tài liệu.
  2. 2 Tìm tài liệu Dùng /ak:scout để tìm file .md và .mdx trong nguồn local, hoặc web_search capability để lấy cấu trúc tài liệu từ URL.
  3. 3 Rút metadata Với mỗi file, rút title H1, mô tả từ đoạn đầu, category section và phân loại core hay optional.
02

Xử lý

Agent / skill thực thi

  1. 4 Sinh index Chạy scripts/generate-llms-txt.py với --source, --output, --base-url và tùy chọn --md-links, --trailing-slash, --full, hoặc làm thủ công theo spec llms.txt được tham chiếu.
  2. 5 Bản .md cho từng trang Khi site hỗ trợ, mỗi trang public có một bản Markdown tại URL trang cộng .md (index.html.md với URL kết thúc bằng /), trả về dạng text/markdown kèm X-Robots-Tag: noindex và được llms.txt link tới qua --md-links. Nếu site không phục vụ được URL .md thì link URL HTML và báo lại chỗ thiếu.
  3. 6 Đúng cấu trúc spec Xuất H1 tên project bắt buộc, blockquote summary khuyến nghị, H2 section, link Markdown kèm mô tả và section ## Optional cuối cho tài liệu có thể bỏ qua.
03

Kiểm chứng

Gate, review, xác thực

  1. 7 Validate link Kiểm H1, blockquote, định dạng link Markdown, vị trí Optional và mô tả súc tích; nếu có site đang chạy thì mọi URL được link phải trả 200 và các URL .md lấy mẫu phải trả text/markdown.
  2. 8 Tôn trọng scope Routing của framework để phục vụ các file, sitemap, robots.txt, social metadata và nút thao tác trên trang thuộc về skill framework của site (với Next.js là phần SEO/GEO trong ak:web-frameworks).
  3. 9 Bảo vệ bí mật Không lộ skill internals, system prompt, env var, config nội bộ, dữ liệu cá nhân hoặc nội dung ngoài scope.

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:llms [path|url] [--full] [--md-links] [--output path] [--base-url base] [--trailing-slash]

Đối số

[path|url]

Đường dẫn hoặc URL nguồn

Nguồn tài liệu cần lập index. Bỏ qua để dò tài liệu từ README gốc, config site và navigation; nếu nguồn là URL, cần fetch hoặc map trước khi chạy generator được bundle vì script chỉ scan directory local.

/ak:llms docs/reference

Option dùng chung

--full

Artifact full

Ghi thêm llms-full.txt có nội dung tài liệu inline. Review kích thước và nội dung riêng tư trước khi publish.

/ak:llms docs --full
--md-links

Link bản .md

Link tới bản Markdown của từng trang (page.md) thay vì URL HTML. Chỉ dùng khi site thật sự phục vụ bản .md.

/ak:llms docs --md-links --base-url https://example.com/docs
--output path

Thư mục output

Ghi llms.txt và mọi llms-full.txt vào thư mục này thay vì root project. Flag này không publish hay deploy file.

/ak:llms docs --output public
--base-url base

URL gốc

Tiền tố URL public cho các link được tạo; skill và script được bundle dùng chung flag này. Không có nó thì link giữ dạng path tương đối kiểu filesystem. Flag này không kiểm HTTP link.

/ak:llms docs --base-url https://example.com/docs
--trailing-slash

URL có dấu / cuối

Site phục vụ trang thư mục dạng guide/ (bản Markdown ở guide/index.html.md). Mặc định là guide và guide.md. Khớp với cấu hình site để URL được link trả 200 mà không redirect.

/ak:llms docs --base-url https://example.com/docs --trailing-slash

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ế.

Index docs mặc định Khuyến nghị
/ak:llms
Dùng khi:
Dùng khi project cần index thân thiện với LLM cho bộ tài liệu đang có.
Kết quả:
Dò tài liệu từ README gốc, config site và navigation, rút title và mô tả, nhóm tài liệu core với optional, ghi llms.txt và validate cấu trúc llmstxt.org bắt buộc.
Nguồn cụ thể
/ak:llms docs/reference
Dùng khi:
Dùng khi chỉ một thư mục hoặc file tài liệu cụ thể nên làm nguồn cho index thân thiện với LLM.
Kết quả:
Dùng path được cung cấp thay vì tự dò tài liệu, phân tích các file .md và .mdx tìm được, phân loại link vào section H2 và xuất llms.txt hợp lệ.
File full context
/ak:llms docs --full
Dùng khi:
Dùng khi AI assistant cần cả index súc tích và file mở rộng có nội dung tài liệu inline.
Kết quả:
Tạo llms.txt chọn lọc cùng llms-full.txt có nội dung inline, rồi kiểm heading, định dạng link Markdown, vị trí Optional và mô tả súc tích.
URL docs đã publish
/ak:llms docs --output public --base-url https://example.com/docs
Dùng khi:
Dùng khi link được tạo cần trỏ tới docs site đã publish và file output cần ghi ngoài root.
Kết quả:
Áp dụng tiền tố URL gốc cho link Markdown được tạo, ghi output vào thư mục đã yêu cầu và để việc phục vụ file, sitemap, robots.txt và social metadata cho skill framework của site.
Bản Markdown của trang
/ak:llms docs --md-links --base-url https://example.com/docs --full
Dùng khi:
Dùng khi site phục vụ bản .md cho mọi trang public và AI nên đọc bản đó thay vì HTML.
Kết quả:
Ghi llms.txt link tới bản .md của từng trang và llms-full.txt có dòng Source cho mỗi trang, rồi kiểm các URL được link trả 200 và URL .md lấy mẫu trả text/markdown.

Phạm vi xử lý

  • Scan tài liệu
  • Cấu trúc llms.txt
  • Ngữ cảnh mở rộng tùy chọn
  • Bản Markdown cho từng trang
  • Validate link
  • Index tài liệu thân thiện với AI

Artifact tạo ra

Đầu ra llms.txt

Mẫu đường dẫn

Luôn có llms.txt; có llms-full.txt khi dùng --full; bản page.md do site phục vụ, không phải do script được bundle ghi ra.

Các file là index tài liệu cho ngữ cảnh LLM; việc phục vụ file, sitemap và cấu hình SEO thuộc về skill framework của site.

Skill liên quan

Tiếp theo