QUY TẮC SOẠN THẢO VĂN BẢN THUẦN
=================================
I. QUY TẮC CHUNG:
- Văn bản thuần không sử dụng định dạng đặc biệt, chỉ dùng ký tự có sẵn trên bàn phím 104 phím chuẩn.
- Không phụ thuộc vào phần mềm soạn thảo đặc biệt.
- Dễ đọc trực tiếp và dễ xử lý tự động.
II. TIÊU ĐỀ VÀ PHÂN CẤP:
A. PHÂN CẤP LỚN:
- Cấp 1: tiền tố "CHƯƠNG" kèm SỐ LA MÃ IN HOA. Tên tiêu đề sử dụng chữ IN HOA.
- Cấp 2: tiền tố "PHẦN" kèm CHỮ CÁI IN HOA. Tên tiêu đề sử dụng chữ IN HOA.
- Cấp 3: tiền tố "Mục" kèm SỐ Ả RẬP. Tên tiêu đề sử dụng chữ IN THƯỜNG.
- Tất cả đều kèm dấu hai chấm.
- Tách biệt với nội dung bằng 1 đường gạch ngang dài 40 ký tự: ----------------------------------------
- Các phân cấp lớn nên gộp chung một dòng nếu độ dài cho phép. Nên tách ra nếu chúng quá dài.
- Ví dụ:
+ Nếu ngắn:
CHƯƠNG I: KHÁI NIỆM - PHẦN A: NHỮNG KHÁI NIỆM CƠ BẢN - Mục 1: Tiếp thị là gì?
----------------------------------------
+ Nếu dài:
CHƯƠNG I: NHỮNG NGUYÊN LÝ CƠ BẢN CỦA HỆ THỐNG TRÍ TUỆ NHÂN TẠO
PHẦN A: MỞ ĐẦU - VÌ SAO CHÚNG TA NÊN XÂY DỰNG HỆ THỐNG TRÍ TUỆ NHÂN TẠO
Mục 1: Nguyên nhân thứ nhất - Tăng năng suất lao động
----------------------------------------
B. ĐÁNH SỐ CẤP BẬC:
- Cấp 1: SỐ LA MÃ IN HOA (I, II, III...) kèm dấu chấm. Tên tiêu đề sử dụng chữ IN HOA.
- Cấp 2: CHỮ CÁI IN HOA (A, B, C...) kèm dấu chấm. Tên tiêu đề sử dụng chữ IN HOA. Thụt lề 1 cấp.
- Cấp 3: CHỮ CÁI THƯỜNG (a, b, c...) kèm dấu chấm. Tên tiêu đề sử dụng chữ IN THƯỜNG. Thụt lề 2 cấp.
- Cấp 4: CHỮ CÁI THƯỜNG kèm SỐ Ả RẬP (a1., a2.,...) kèm dấu chấm. Tên tiêu đề sử dụng chữ IN THƯỜNG. Thụt lề 3 cấp.
- Cấp 5 và thấp hơn nữa: thêm vào 1 chữ số Ả Rập (a1.1., a1.1.1.,...). Thụt lề 4-5-6... cấp.
- Sử dụng phím Tab để tách biệt số cấp bậc và nội dung tiêu đề.
- Ví dụ:
I. CHÚNG TA CÓ GÌ?
A. CHÚNG TA CẦN GÌ?
a. Chúng ta muốn gì?
a1. Khi nào chúng ta làm?
a1.1. Chúng ta làm gì?
a1.1.1. Và sau đó?
a1.1.2. Rồi sao nữa?
a1.2. Chúng ta sẽ làm gì?
a1.3. Chúng ta thế nào?
a2. Và sao?
Nội dung
C. Nguyên tắc: muốn chuyển sang cấp cao hơn cần cách dòng.
III. DANH SÁCH:
A. DANH SÁCH CÓ THỨ TỰ:
- Sử dụng số Ả Rập kèm theo dấu chấm là định dạng cơ bản.
- Có thể sử dụng tiền tố để biểu diễn. Công thức: + số Ả Rập + dấu hai chấm. Ví dụ: Bước 1:
B. DANH SÁCH KHÔNG THỨ TỰ:
- Sử dụng lần lượt các dấu gạch ngang, dấu cộng, dấu sao cho từng cấp.
- Thụt lề để phân biệt cấp bậc.
C. DANH SÁCH KIỂM TRA:
- [x] Đã hoàn thành.
- [ ] Chưa hoàn thành.
IV. NỘI DUNG ĐƯỢC NHẤN MẠNH:
- IN HOA để thay cho in đậm, in nghiêng và gạch chân.
- Không dùng dấu nháy kép cho nội dung được nhấn mạnh vì dễ nhầm lẫn với trích dẫn.
- Không dùng dấu ngoặc đơn cho nội dung được nhấn mạnh vì dễ nhầm lẫn với đường dẫn.
V. LIÊN KẾT VÀ TRÍCH DẪN:
- Đường dẫn: (đường_dẫn_tương_đối_hoặc_url).
- Trích dẫn: "nội dung trích dẫn".
VI. KHỐI ĐẶC BIỆT:
A. KHỐI MÃ NGUỒN:
=== [NGÔN NGỮ_LẬP_TRÌNH] ===
Nội dung mã nguồn
=== KẾT THÚC MÃ ===
Ví dụ:
=== [JAVASCRIPT] ===
console.log("Hello World");
=== KẾT THÚC MÃ ===
B. KHỐI TRÍCH DẪN:
*** [NGUỒN_TRÍCH_DẪN] ***
Nội dung trích dẫn
*** KẾT THÚC TRÍCH DẪN ***
Ví dụ:
*** [Wikipedia - Ngôn ngữ lập trình JavaScript] ***
JavaScript là ngôn ngữ lập trình đa paradigm, hỗ trợ lập trình hướng đối tượng, hàm và mệnh lệnh.
*** KẾT THÚC TRÍCH DẪN ***
VII. BẢNG BIỂU VÀ BIỂU ĐỒ:
- Sơ đồ cây: dùng khối trích dẫn để ghi tiêu đề biểu đồ, dùng danh sách không thứ tự để vẽ sơ đồ. Ví dụ:
*** [Kiến trúc dự án] ***
Mã lệnh trang mạng/
- cau-hinh/
+ duong-dan.path
- khuon-mau/
+ template.html
+ sieu-du-lieu.md
- bai-viet/
+ index.md
+ color-palette.md
+ bai-viet-cu/
* kien-truc-cu.md
* readme.md
*** KẾT THÚC SƠ ĐỒ ***
- Biểu đồ tọa độ Đề Các: trục hoành dùng để biểu thị giá trị số (tỉ lệ 1 ký tự = n đơn vị), trục tung dùng để liệt kê danh mục hoặc mốc thời gian (cố định theo dòng), ký tự vẽ: |, -, # (thanh giá trị), V (mũi tên xuống), nếu số lẻ không khớp với ký tự # có thể dùng dấu . ở cuối thanh để biểu thị số lẻ này (bắt buộc kèm theo giá trị cụ thể). Ví dụ:
*** [DOANH THU THEO THÁNG] ***
0----5----10---15---20---25---30---35---40--> (triệu VNĐ)
Tháng 1 |###################### (22)
Tháng 2 |########################### (27)
Tháng 3 |####################################### (39)
v
(tháng)
*** KẾT THÚC BIỂU ĐỒ ***
- Biểu đồ phần trăm: sử dụng khung cố định 20 ký tự (mỗi ký tự tương ứng 5%), dùng dấu # cho phần đã hoàn thành và - cho phần còn lại, đặt giá trị phần trăm cụ thể ở cuối dòng. Ví dụ:
*** [TIẾN ĐỘ DỰ ÁN] ***
Thiết kế : [##########----------] 50%
Lập trình : [######--------------] 30%
Kiểm thử : [--------------------] 0%
Hoàn tất : [####################] 100%
*** KẾT THÚC BIỂU ĐỒ ***
- Biểu đồ luồng: dùng ngoặc vuông [] cho các bước hành động/thực thể, dùng ngoặc đơn () cho điều kiện, dùng mũi tên đơn xuống | và v để chỉ hướng chính, dùng gạch nối -- và > cho các nhánh rẽ ngang. Ví dụ:
*** [QUY TRÌNH DUYỆT ĐƠN] ***
[Khách đặt hàng]
|
v
[Kiểm tra kho] --(Hết hàng)--> [Hủy đơn]
|
(Còn hàng)
v
[Đóng gói] -> [Giao hàng]
|
v
[Hoàn tất]
*** KẾT THÚC SƠ ĐỒ ***
- Bảng: dùng các dấu | để vẽ bảng, chèn thêm phím Tab để bảng được đều, phân cách dòng tiêu đề bằng hàng dấu -, phân cách cột khóa chính bằng dấu ||. Ví dụ:
*** [THÔNG TIN NHÂN VIÊN] ***
|STT ||Tên |Vị trí |Năm sinh |Địa chỉ |Số điện thoại |
-----------------------------------------------------------------------------
|1 ||Nguyễn Thị Tú |Tiếp thị |1993 |80, Lê Lợi |0913654523 |
|2 ||Trần Văn Hên |Vận hành |1988 |53, Tân Sơn|0345685252 |
*** KẾT THÚC BẢNG ***
- Cố gắng dùng ngôn ngữ thuần để mô tả.
VIII. BÌNH LUẬN VÀ GHI CHÚ
- Sử dụng cặp dấu sổ trái để chèn 1 đoạn bình luận hoặc ghi chú. Có thể là 1 dòng riêng, hoặc nằm cuối 1 dòng cụ thể. Ví dụ:
Đây là thông tin chính thức. //Đây là thông tin bình luận trên cùng 1 dòng
//Đây là thông tin bình luận trên dòng tách biệt
- Không dùng dấu thăng # do dễ lẫn lộn với cách đánh dấu tiêu đề markdown. Không dùng cặp dấu do phức tạp.
IX. QUY TẮC ĐẶT TÊN TỆP:
- Không dấu (tránh lỗi mã hóa).
- Thay thế khoảng trắng bằng dấu gạch ngang (tự động hóa không cần thêm dấu nháy kép).
- Không dùng các ký tự bị cấm trên Windows: <>:"/\|?*
- Luôn luôn có phần mở rộng tệp.