Blog Guideline

Bài viết được Reup lại và chỉnh sửa 1 số phần từ Tomoblo

Mục đích:

1. Tạo 1 guideline để việc viết blog trở nên đơn giản và vui vẻ hơn.
2. Tạo ra 1 tiêu chuẩn chung, thống nhất cho các bài viết.

1. Chúng ta viết blog để làm gì ?

“Viết blog vì sếp em bắt viết”, “Viết blog vì KPI bắt thế”, …

Nếu em nghĩ thế, thì việc viết blog chỉ phí thời gian của em và cả của người đọc.

Chúng ta viết blog để :

1. Chia sẻ kiến thức, tạo môi trường cởi mở, học hỏi.
2. Tạo động lực để trau dồi kiến thức.
3. Rèn luyện kĩ năng tư duy, trình bày, giải thích.

Vì thế, anh muốn những bài viết trên blog phải thể hiện được sự tâm huyết và niềm vui của người viết.

2. Tomoblo là blog công nghệ

Blog của công ty là blog công nghệ, thế nên có sự khác biệt :

1. Đầu tiên, nó là công nghệ. Nội dung các bài viết nên về các công nghệ, xu hướng công nghệ mới.
2. Văn phong của blog công nghệ có những đặc điểm : dễ hiểu, cấu trúc rõ ràng, sử dụng nhiều hình vẽ, công thức. Giọng văn vui vẻ, thoải mái.
3. Cách trình bày khoa học, hướng tới người đọc.

3. Guideline

3.1 Thông tin bảo mật

Cả người viết và người review đều phải kiểm tra lại thật kĩ về code, hình ảnh, các thông tin trong bài viết xem có liên quan tới các dự án của khách hàng hay không.

Tuyệt đối không copy code từ các dự án.

3.2 Đánh số thứ tự

Đánh số thứ tự các headline h1 bằng số thường. Ví dụ :

1. Docker là gì ?

Đánh số thứ tự các headline h2 theo format : số thứ tự của h1 + số thứ tự. Ví dụ :

2. Install Docker
2.1 Ubuntu
2.2 MacOS

3.3 Giải thích môi trường, version

Phần đầu của bài viết nên có 1 phần với về các công cụ, phần mềm, framework, ngôn ngữ được sử dụng trong bài viết.

Các framework, ngôn ngữ lập trình được nâng cấp liên tục, mỗi version lại có thêm các tính năng mới, fix các lỗi cũ, nên việc 1 đoạn code chạy ngon trên version này lại chết trên 1 version khác là chuyện bình thường.

Ví dụ :

Ruby 2.2/CentOS 6.5
Docker 17.1 / MacOS 
XCode 12

3.4 Tóm lược

Nên có 1 phần tóm lược ngắn gọn ở phần đầu mỗi bài viết. Tại sao ta viết bài này, bài này nói về cái gì, … để người đọc có thể ngay lập tức hiểu được vấn đề trong bài viết.

3.5 Dẫn nguồn và link tham khảo đầy đủ

Trong trường hợp anh em tham khảo bài viết của người khác, thì phải dẫn nguồn đầy đủ để bảo vệ quyền tác giả. Ngoài ra việc thêm nguồn vào còn giúp người đọc dễ tham khảo hơn.

Ví dụ :

prng = Random.new
prng.rand(100)       # => 42

（Bạn có thể tham khảo thêm tại https://apidock.com/ruby/Random/rand)

3.6 Giọng văn

1 trong các mục đích khi viết blog của chúng ta là rèn luyện tư duy, kĩ năng trình bày, giải thích, thế nên anh em hãy :

1. Sử dụng câu văn có câu trúc đơn giản như “Vì …, nên …”, “Nếu …, thì …”.
2. Nên viết có ví dụ kèm theo.
3. Khi liệt kê vấn đề, nên gạch đầu dòng, đánh số thứ tự.
4. Nói 100 câu không bằng 1 hình ảnh.
5. Dùng đại từ nhân xưng : mình-bạn, chúng ta

3.7 Thêm tags

Anh em nên thêm tags cho bài viết của mình. Nếu được thì nên thêm từ 3, 4 tags cho 1 bài viết.

Thêm tags như thế sau này dễ theo dõi các bài viết cùng 1 chủ đề hơn.

4. Tips

Để bắt đầu viết 1 bài blog đầu tiên, anh nghĩ sẽ khá khó khăn vì không biết phải bắt đầu từ đâu.

Vậy nên mọi người hãy sử dụng mindmap. Bắt đầu với 1 từ khoá, sau đó tách thành các ý chính h1 (thẻ h2). Rồi cụ thể hoá các ý chính h1 (thẻ h2) thành h2 (thẻ h3). Sau đó viết chi tiết cho từng mục.

Với cách viết này, em có thể viết 1 bài viết trong 3, 4 ngày mà không bị quên, bị mất hứng viết.

Hi vọng bài viết này giúp anh em nắm được cách viết 1 bài blog đơn giản, dễ đọc, dễ hiểu.

– From rockkhuya with love