Tài liệu (Docs)
Một số lý thuyết về cách tạo, viết nội dung tài liệu (documentation)
Documentation là một tính năng viết tài liệu trên website Docs Blog, tính năng này cho phép bạn viết các tài liệu kỹ thuật hoặc bất kỳ kiến thức nào.
Trang dạng tài liệu khác với những trang hoặc bài viết bởi cấu trúc cây thư mục, giúp bạn nắm rõ từng chủ đề cụ thể.
Trong phần quản lý nội dung, để xem các trang tài liệu, bạn có thể lọc theo loại "Documentation Page".
Tạo tài liệu
Để tạo một trang tài liệu, nhấn vào nút Create a new page -> Documentation Page.
Cấu hình
Một trang tài liệu được chia làm hai phần: Main và SEO & Metadata.
- Main: Cấu hình trang tài liệu, thêm nội dung.
- SEO & Metadata: Cấu hình SEO cho trang.
Main
Cấu hình chính (main) của một trang tài liệu
bao gồm:
- UID: đường dẫn (url) của website.
- Tiêu đề: Tiêu đề của trang tài liệu.
- Mô tả: Mô tả ngắn gọn của trang tài liệu.
- Trang cha: Đây là phần phân cấp thư mục, nếu bạn muốn trang này thuộc một mục của trang cha nào đó -> Chọn trang cha. Còn nếu không thuộc trang nào thì không cần chọn.
- Thứ tự hiển thị tài liệu: Đây là phần hiển thị thứ tự trên website, bạn muốn trang A đứng trước trang B, trang B đứng trước trang A... cấu hình theo số thứ tự, số nào nhỏ sẽ được đứng trước.
❗️ Một số lưu ý quan trọng:
- UID (Unique ID) - định danh duy nhất, nó là đường dẫn hiển thị trên website. Nó giống như CCCD, UID không được phép trùng nhau.
- Không dấu: Tránh sử dụng dấu tiếng Việt, thay vào đó dùng chữ cái tiếng anh và dấu gạch ngang (-) để phân cách các từ.
- Đơn giản: Đặt tên nên ngắn gọn, dễ nhớ và dễ hiểu.
Ví dụ: trang-tai-lieu
Thứ tự hiển thị tài liệu: Được sắp xếp theo số, số nào nhỏ sẽ hiển thị trước, nếu trang đó thuộc trang cha thì có thể reset số thứ tự từ đầu. Để được tối ưu nên chọn số cách nhau xa xa.
Chẳng hạn bạn xếp theo số thứ tự :
- Tài liệu A: 1
- Tài liệu B: 2
- Tài liệu C: 3
Trường hợp bạn có tài liệu D muốn nằm giữa A và B, bạn phải vào lại từng trang và chỉnh số thứ tự lại A(1), D(2), B(3), C(4). Điều này khá cực, thế nên khi chọn số, hãy chọn số xa xa nhau, chẳng hạn như 10, 20, 30... thì khi đó, nếu thêm tài liệu D ta có thể để A(10), D(11), B(20)... chỉ cần chỉnh tài liệu D, không cần chỉnh các tài liệu khác.
SEO & Metadata
Đây là nơi cấu hình SEO cho tài liệu này. Chúng sẽ hiển thị khi bạn chia sẻ lên MXH hoặc nơi nào đó trên website.
Viết tài liệu
Mặc định, trang tài liệu không có để sẵn nội dung, bạn ấn chọn Add slice.
Chọn Text slice để viết nội dung.
Bạn có thể bắt đầu viết nội dung, nếu có cần thêm thì bạn chỉ cần ấn + hoặc ấn giữ chúng để kéo thả (đổi vị trí hiển thị).