Bỏ qua

Chuẩn trình bày bài viết

Mục tiêu: bài viết dễ đọc trên điện thoại, dễ tra cứu và nhất quán giữa các tác giả. Dưới đây là các mẫu dùng thường xuyên.

1. Cấu trúc tiêu đề

  • Một bài chỉ có một # (H1) — thường trùng tiêu đề bài.
  • Chia nội dung bằng ##, chi tiết bằng ###. Không nhảy cấp (H1 → H3).
  • Câu ngắn, mỗi đoạn 2–4 câu. Tránh đoạn dài quá 5 dòng trên điện thoại.
# Tiêu đề bài

Đoạn mở đầu: vấn đề, phạm vi, kết luận chính.

<!-- more -->

## 1. Bối cảnh

### 1.1. Chi tiết

## 2. Kết luận

2. Bảng dữ liệu

Dùng cho thông số, so sánh, tra cứu:

| Kích thước (inch) | Đường kính ngoài (mm) | Sch 40 (mm) |
| :--- | ---: | ---: |
| 2" | 60,3 | 3,91 |
| 4" | 114,3 | 6,02 |
| 6" | 168,3 | 7,11 |
Kích thước (inch) Đường kính ngoài (mm) Sch 40 (mm)
2" 60,3 3,91
4" 114,3 6,02
6" 168,3 7,11

Quy ước: :--- căn trái (văn bản), ---: căn phải (số), :---: căn giữa. Đơn vị ghi ngay trong tiêu đề cột.

3. Công thức

Công thức trong dòng: $Q = A \cdot v$ → \(Q = A \cdot v\).

Công thức riêng:

$$
t = \frac{P \cdot D}{2\left(S \cdot E \cdot W + P \cdot Y\right)}
$$
\[ t = \frac{P \cdot D}{2\left(S \cdot E \cdot W + P \cdot Y\right)} \]

Luôn định nghĩa ký hiệu ngay sau công thức (bảng hoặc danh sách) và ghi rõ đơn vị.

4. Khối mã và lệnh

Dùng ba dấu backtick kèm ngôn ngữ để tô màu cú pháp:

py -3.12 -m mkdocs serve

Với lệnh dài, thêm chú thích bằng #. Tránh dán ảnh chụp màn hình thay cho mã — không sao chép được.

5. Ghi chú, cảnh báo

!!! note "Ghi chú"
    Thông tin bổ sung, không bắt buộc đọc.

!!! tip "Mẹo"
    Cách làm nhanh hơn.

!!! warning "Lưu ý"
    Điều kiện áp dụng, giới hạn.

!!! danger "Nguy hiểm"
    Sai sót có thể gây hậu quả nghiêm trọng.

Dùng tiết chế: một bài nên có tối đa 2–3 khối ghi chú.

6. Hình ảnh và sơ đồ

Ảnh:

![Sơ đồ nguyên lý hệ thống lọc](/assets/images/so-do-loc.jpg)

Sơ đồ bằng Mermaid (tự vẽ, không cần ảnh):

```mermaid
flowchart LR
    A[Nước nguồn] --> B[Lắng] --> C[Lọc] --> D[Khử trùng]
```

flowchart LR
    A[Nước nguồn] --> B[Lắng] --> C[Lọc] --> D[Khử trùng]

7. SEO cơ bản

Yếu tố Quy tắc
Tiêu đề 50–60 ký tự, chứa từ khóa chính, không viết hoa toàn bộ
description 140–160 ký tự, nêu giá trị bài viết
URL Ngắn, không dấu, có từ khóa
Ảnh Alt text mô tả nội dung, tên file có nghĩa
Tiêu đề phụ Mỗi H2 trả lời một câu hỏi của người đọc

8. Checklist cuối bài

  • Có kết luận hoặc phần "áp dụng / lưu ý".
  • Số liệu có đơn vị và nguồn.
  • Thuật ngữ tiếng Anh được giải thích lần đầu xuất hiện.
  • Đã kiểm tra hiển thị trên màn hình điện thoại.
  • Đã đọc lại toàn bài để bắt lỗi chính tả.
Viết bài