Giới thiệu Weasel Wiki
This content is not available in your language yet.
Weasel Wiki là nơi lưu lại kiến thức đã tra cứu nhiều hơn một lần. Nguyên tắc duy nhất: thứ gì phải tìm lại lần thứ hai thì đáng được viết xuống.
Trong wiki có gì
Phần tiêu đề “Trong wiki có gì”| Nhóm | Đường dẫn | Nội dung |
|---|---|---|
| Sổ tay Wiki | /wiki/ |
Cách wiki vận hành, quy ước viết, mẫu trình bày. |
| Ghi chú kỹ thuật | /ky-thuat/ |
Git, code review, Docker, công cụ hằng ngày. |
| Quy trình & Vận hành | /quy-trinh/ |
Onboarding, checklist phát hành, runbook sự cố. |
| Chứng chỉ | /aws-clf-c02/ |
Bộ 20 chương ôn thi AWS Cloud Practitioner. |
| Thuật ngữ | /thuat-ngu/ |
Từ điển ngắn, tra nhanh khi đọc tài liệu tiếng Anh. |
Bốn loại tài liệu
Phần tiêu đề “Bốn loại tài liệu”Mỗi trang thuộc đúng một trong bốn loại của Diátaxis. Trộn loại là lý do chính khiến tài liệu vừa dài vừa khó dùng.
- Hướng dẫn (tutorial) — người mới, đi từ số 0 tới kết quả chạy được. Ưu tiên “làm được”, không giải thích sâu.
- Cách làm (how-to) — một việc cụ thể, người đọc đã có bối cảnh. Dạng các bước, ghi rõ điều kiện tiên quyết.
- Tra cứu (reference) — bảng, tham số, cú pháp. Chính xác, đầy đủ, không kể chuyện.
- Diễn giải (explanation) — vì sao, đánh đổi, khi nào không nên dùng.
Quy ước chung
Phần tiêu đề “Quy ước chung”- Viết tiếng Việt; giữ nguyên thuật ngữ tiếng Anh khi bản dịch gây mơ hồ (
load balancer,pull request). - Lần đầu dùng thuật ngữ: ghi tiếng Anh trong ngoặc, ví dụ “cân bằng tải (load balancer)”.
- Mỗi trang có
titlevàdescriptiontrong frontmatter —descriptionlà thứ hiện trong kết quả tìm kiếm. - Câu lệnh đặt trong khối mã có tên ngôn ngữ, không kèm ký tự nhắc lệnh
$. - Trang quá 300 dòng thì tách. Trang dưới 20 dòng thì gộp vào trang khác.
Đọc tiếp
Phần tiêu đề “Đọc tiếp”- Cách đóng góp — thêm trang mới, đặt tên file, khai báo sidebar.
- Mẫu trình bày — component sẵn có và khi nào dùng cái nào.