Viet Readme Writer

Viết README repo tiếng Việt hoặc song ngữ. Dùng khi tạo README mới, sửa README dài vô dụng, hoặc cần fold đầu tiên giải thích được trong 10 giây.

gonegirl07 Updated

File contents

viet-readme-writer

Viết README để người lạ star hoặc clone được, không phải tiểu luận.

Khi nào dùng

  • Repo mới chưa có README tử tế
  • README hiện tại toàn badge và slogan
  • Cần bản VI, EN, hoặc VI+EN

Không dùng

  • Docs API đầy đủ (để file docs/)
  • Changelog

Bước

  1. Đọc code, script start, license, stack thật. Không bịa tính năng.
  2. Fold đầu — một câu repo làm gì, 1 lệnh chạy, ví dụ, bảng lệnh.
  3. Tiếng Việt ngắn. Thuật ngữ kỹ thuật giữ EN.
  4. Xóa “chào mừng bạn đến với”, “được xây dựng nhằm mục đích”.

Ví dụ fold

doi-ten

Đổi tên hàng trăm file theo pattern, chạy local, không upload.

Checklist

  • Câu đầu không chứa “awesome”, “powerful”
  • Lệnh chạy thật
  • Không bịa screenshot

gonegirl07/awesome-vn-agent-skills/tree/main/skills/viet-readme-writer commit 39dee0f01d

Frequently asked questions

npx skillmds@latest add gonegirl07/viet-readme-writer