Ra mắt FDS-Dev — công cụ tất cả trong một cho linting tài liệu + dịch AI dành cho lập trình viên không nói tiếng Anh
(github.com/flamehaven01)Ra mắt FDS-Dev — công cụ tất cả trong một cho linting tài liệu + dịch AI dành cho lập trình viên không nói tiếng Anh
🤔 Một trong những rào cản lớn nhất mà lập trình viên không nói tiếng Anh cảm nhận trong thế giới mã nguồn mở là việc viết tài liệu bằng tiếng Anh.
Nhiều người rất tự tin với code, nhưng khi bắt tay vào sắp xếp README, chú thích hay tài liệu bằng tiếng Anh thì lại bất giác chần chừ.
Dù chúng ta đang sống trong thời đại có thể nhờ đến sự trợ giúp của các công cụ dịch AI,
“Liệu cách diễn đạt này có thật sự tự nhiên không?”
“Nội dung mình muốn truyền đạt đã được chuyển tải đúng chưa?”
Có lẽ nhiều người từng băn khoăn như vậy.
Bản thân tôi cũng đã làm việc ở nước ngoài với vai trò lập trình viên hơn 15 năm, nhưng
vẫn thấy suy nghĩ và viết bằng tiếng Hàn là tự nhiên nhất.
Vì thế, khi mải tập trung phát triển, tôi thường để lại chú thích bằng tiếng Hàn, và đến lúc muốn整理 tài liệu thì lại nghĩ rằng
“Nếu đăng lên lúc này, liệu người ta có nghĩ mình là kiểu lập trình viên không quan tâm đến chất lượng tài liệu không…”
Và đã không ít lần tôi do dự.
Sau những trăn trở đó, tôi nghĩ sẽ thật tốt nếu có một công cụ giúp các lập trình viên không nói tiếng Anh như tôi bớt đi phần nào gánh nặng.
Vì vậy tôi đã tạo ra nó.
💡 Giới hạn của các linter hiện có: “Rất tuyệt vời, nhưng lấy tiếng Anh làm trung tâm”
Hiện đã có nhiều công cụ kiểm tra chất lượng tài liệu rất xuất sắc.
- 🔺 markdownlint → kiểm tra cú pháp và style Markdown
- 🔺 Vale → kiểm tra tone, tính nhất quán của thuật ngữ và hướng dẫn văn phong
Những công cụ này cực kỳ mạnh mẽ trong việc duy trì chất lượng tài liệu trên GitHub.
Tuy nhiên, vấn đề là chúng được thiết kế với giả định người dùng là lập trình viên nói tiếng Anh.
Khi các lập trình viên không nói tiếng Anh ở Hàn Quốc, Nhật Bản, Đức, Trung Quốc... viết tài liệu bằng ngôn ngữ bản địa của mình:
- lint không hoạt động đúng cách
- style guide dựa trên câu tiếng Anh
- môi trường dịch thuật/đa ngôn ngữ không được tính đến
Cuối cùng, gánh nặng “phải viết lại bằng tiếng Anh” vẫn còn nguyên.
🚀 Vì thế FDS-Dev đã ra đời
✨ 1) Linter tài liệu siêu nhanh dựa trên cấu trúc
Không chỉ dừng ở kiểm tra style đơn thuần, công cụ còn tự động kiểm tra cả cấu trúc tài liệu chuyên nghiệp như:
- ▪️ thứ tự các section
- ▪️ các header bắt buộc
- ▪️ toàn bộ bố cục tài liệu
✨ 2) Trình dịch nhận diện code dựa trên AI
Khi dịch tài liệu, chú thích và docstring:
- ▪️ bảo vệ code block
- ▪️ giữ nguyên CamelCase / snake_case
- ▪️ duy trì chính xác các thuật ngữ kỹ thuật
Tài liệu được viết bằng tiếng mẹ đẻ có thể được tự động chuyển đổi thành tài liệu tiếng Anh ở mức production.
✨ 3) Công cụ “quốc tế hóa ở cấp độ code” đầu tiên dành cho lập trình viên không nói tiếng Anh
Giờ đây, ngay cả khi không viết tài liệu bằng tiếng Anh,
bạn vẫn có thể tạo ra tài liệu mà bất kỳ ai trên thế giới cũng có thể hiểu được.
⚙️ Cách sử dụng đơn giản
pip install --upgrade fds-dev
fds translate README.ko.md --output README.md
fds lint README.md
DeepL, LibreTranslate 등 다양한 번역 백엔드 선택 가능하며
GitHub Actions · Docker 환경도 완벽 지원합니다.
🌏 Hãy đóng góp cho mã nguồn mở
FDS-Dev hiện vẫn đang phát triển rất nhanh.
⭐ Star, Issue và PR của các bạn sẽ định hình hướng đi của dự án này.
🙌 Tôi muốn cùng mọi người tạo ra một tiêu chuẩn mới cho lập trình viên không nói tiếng Anh
Một môi trường nơi bạn có thể tập trung vào code mà không bị áp lực bởi việc viết tài liệu,
và một hệ sinh thái nơi bạn có thể đóng góp cho mã nguồn mở toàn cầu mà không bị rào cản ngôn ngữ—
Tôi hy vọng FDS-Dev sẽ trở thành điểm khởi đầu cho điều đó.
Rất mong nhận được sự quan tâm và tham gia của mọi người!
4 bình luận
🔥 FDS-Dev v0.0.4 — xin chia sẻ tin cập nhật hôm nay
Tôi đang tiếp tục cải thiện FDS-Dev trong quá trình sử dụng thực tế.
Xin chia sẻ ngắn gọn nội dung bản cập nhật v0.0.4 (2025-12-08) được phát hành hôm nay.
✅ Các thay đổi chính
Cải thiện logic phân tích Config
Giờ đây,
.fdsrc.yamlsẽ được tự động tìm kiếm dựa trên vị trí thực thi lint/translate.Ngay cả khi thay đổi cấu hình theo từng thư mục, cũng sẽ được áp dụng ngay mà không cần di chuyển bằng
cd.Tăng cường độ ổn định của pipeline dịch
Khi dùng
language: auto, đã ngăn lỗi crash từng phát sinh do thiếu đối tượng ngôn ngữ.DeepL sử dụng thời gian chờ mặc định 5 giây cùng thông báo lỗi rõ ràng, qua đó giải quyết vấn đề CLI bị treo.
Dọn dẹp chất lượng mã nguồn
Trên toàn bộ module, đã chuẩn hóa line ending, xóa khoảng trắng thừa ở cuối dòng, và bổ sung docstring tối thiểu.
Đã đưa vào
.pylintrcriêng cho dự án để chỉ bắt các “lỗi thực chất” mà không xung đột với style của Black/Ruff.🧪 Kiểm thử
Đã vượt qua 110 bài kiểm thử
pytestĐạt điểm
pylint fds_dev10.00/10Tôi đang phát triển dự án này thành một “công cụ tự động hóa chất lượng tài liệu/mã nguồn dựa trên ngôn ngữ quy mô nhỏ”,
và đang commit mỗi ngày để liên tục nâng cao độ ổn định và chất lượng kỹ thuật.
Nếu bạn quan tâm, hãy ghé xem repository:
https://github.com/flamehaven01/FDS-Dev
Mọi đề xuất tính năng cần thiết hoặc issue cũng luôn được chào đón!
Đã phát hành phiên bản v0.0.3. Bản cập nhật lần này tập trung mạnh vào việc tăng cường bảo mật và chất lượng kỹ thuật.
Các thay đổi chính như sau:
Bảo mật: bổ sung SECURITY.md, quy trình báo cáo lỗ hổng, cập nhật Dependabot hằng tuần, secret scanning, branch protection, checklist bảo mật
Chất lượng kỹ thuật: pre-commit hooks (black/ruff/isort/yamllint/detect-secrets), áp dụng bắt buộc 70% test coverage cho CI, mypy (strict), hợp nhất cấu hình của tất cả công cụ vào
pyproject.tomlCI/CD: tích hợp báo cáo coverage, type checking và multi-lint
Tài liệu: hướng dẫn triển khai cho doanh nghiệp bao gồm các mẫu Docker/Kubernetes/monorepo, cập nhật tutorial 10 phút
Mã ví dụ: bổ sung ví dụ cơ bản/nâng cao
Điểm chất lượng toàn bộ repository đã được cải thiện từ 10% → 72.5%.
Ghi chú phát hành: https://github.com/flamehaven01/FDS-Dev/releases/tag/v0.0.3
Luôn hoan nghênh mọi phản hồi.
Dự án mã nguồn mở dùng giấy phép MIT sao :) Những dự án như thế này lúc nào cũng rất đáng hoan nghênh.
Cảm ơn bạn đã đón nhận tích cực! 🙂
Lý do chúng tôi duy trì dự án theo giấy phép MIT cũng là để bất kỳ ai cũng có thể tự do mang về sử dụng và phát triển cho phù hợp với môi trường đội nhóm hoặc công ty của mình.
Đặc biệt, trong bản v0.0.3 lần này, chúng tôi đã tăng cường đáng kể nền tảng bảo mật/kỹ thuật, nên
từ các dự án cá nhân nhỏ đến môi trường doanh nghiệp, bạn đều có thể sử dụng một cách thoải mái.
Nếu trong quá trình dùng bạn có ý tưởng cải thiện hay đề xuất nào, cứ cho chúng tôi biết bất cứ lúc nào nhé! 🙌