Hướng dẫn về quy tắc lập trình tài liệu của Bazel

Cảm ơn bạn đã đóng góp cho tài liệu của Bazel. Đây là hướng dẫn nhanh về phong cách viết tài liệu để giúp bạn bắt đầu. Đối với mọi câu hỏi về văn phong chưa được hướng dẫn này giải đáp, hãy làm theo hướng dẫn văn phong viết tài liệu cho nhà phát triển của Google.

Xác định các nguyên tắc

Tài liệu Bazel phải tuân thủ các nguyên tắc sau:

• Ngắn gọn. Sử dụng ít từ nhất có thể.
• Xoá. Sử dụng ngôn ngữ đơn giản. Viết mà không dùng thuật ngữ chuyên ngành cho trình độ đọc của học sinh lớp 5.
• Nhất quán. Sử dụng cùng một từ hoặc cụm từ cho các khái niệm lặp lại trong toàn bộ tài liệu.
• Chính xác. Viết theo cách đảm bảo nội dung luôn chính xác trong thời gian dài nhất có thể bằng cách tránh thông tin và lời hứa dựa trên thời gian cho tương lai.

Viết

Phần này chứa các mẹo viết cơ bản.

Tiêu đề

• Tiêu đề cấp trang bắt đầu từ H2. (Tiêu đề H1 được dùng làm tiêu đề trang.)

• Hãy tạo tiêu đề ngắn gọn nhất có thể. Bằng cách này, chúng sẽ vừa với mục lục mà không bị xuống dòng.

  • Có: Quyền
  • Không: Lưu ý ngắn gọn về quyền

• Sử dụng cách viết hoa đầu câu cho tiêu đề

  • Có: Thiết lập không gian làm việc
  • Không: Thiết lập không gian làm việc

• Cố gắng tạo các tiêu đề dựa trên nhiệm vụ hoặc có thể hành động. Nếu tiêu đề mang tính khái niệm, thì tiêu đề đó có thể dựa trên sự hiểu biết, nhưng hãy viết về những việc mà người dùng làm.

  • Có: Giữ nguyên thứ tự biểu đồ
  • Không: Về việc giữ nguyên thứ tự của biểu đồ

Tên

• Viết hoa danh từ riêng, chẳng hạn như Bazel và Starlark.

  • Có: Ở cuối quá trình tạo, Bazel sẽ in các mục tiêu được yêu cầu.
  • Không: Ở cuối quá trình tạo, bazel sẽ in các mục tiêu được yêu cầu.

• Hãy nhất quán. Đừng giới thiệu tên mới cho các khái niệm hiện có. Nếu có, hãy sử dụng thuật ngữ được xác định trong Bảng chú giải.

  • Ví dụ: nếu bạn đang viết về việc đưa ra lệnh trên một thiết bị đầu cuối, đừng sử dụng cả thiết bị đầu cuối và dòng lệnh trên trang.

Phạm vi trang

• Mỗi trang phải có một mục đích và mục đích đó phải được xác định ngay từ đầu. Nhờ đó, độc giả có thể tìm thấy thông tin họ cần nhanh hơn.

  • Có: Trang này trình bày cách cài đặt Bazel trên Windows.
  • Không: (Không có câu giới thiệu.)

• Ở cuối trang, hãy cho người đọc biết việc cần làm tiếp theo. Đối với những trang không có hành động rõ ràng, bạn có thể thêm đường liên kết đến các khái niệm tương tự, ví dụ hoặc các cách khám phá khác.

Tiêu đề

Trong tài liệu Bazel, đối tượng chủ yếu là người dùng – những người sử dụng Bazel để tạo phần mềm của họ.

• Gọi người đọc là "bạn". (Nếu vì lý do nào đó mà bạn không thể dùng "bạn", hãy dùng ngôn ngữ trung tính về giới tính, chẳng hạn như họ.)

  • Có: Để tạo mã Java bằng Bazel, bạn phải cài đặt JDK.
  • CÓ THỂ: Để tạo mã Java bằng Bazel, người dùng phải cài đặt JDK.
  • Không: Để tạo mã Java bằng Bazel, người dùng phải cài đặt JDK.

• Nếu đối tượng của bạn KHÔNG phải là người dùng Bazel nói chung, hãy xác định đối tượng ở đầu trang hoặc trong phần. Các đối tượng khác có thể bao gồm người duy trì, người đóng góp, người di chuyển hoặc các vai trò khác.

• Tránh dùng từ "chúng tôi". Trong tài liệu người dùng, không có tác giả; chỉ cần cho mọi người biết những gì có thể.

  • Có: Khi Bazel phát triển, bạn nên cập nhật cơ sở mã để duy trì khả năng tương thích.
  • Không: Bazel đang phát triển và chúng tôi sẽ thực hiện các thay đổi đối với Bazel. Đôi khi, những thay đổi này sẽ không tương thích và yêu cầu người dùng Bazel thực hiện một số thay đổi.

Temporal

Nếu có thể, hãy tránh những cụm từ định hướng mọi thứ theo thời gian, chẳng hạn như đề cập đến ngày cụ thể (Quý 2 năm 2022) hoặc nói "hiện tại", "ngay bây giờ" hoặc "sắp tới". Những thông tin này nhanh chóng trở nên lỗi thời và có thể không chính xác nếu là thông tin dự đoán trong tương lai. Thay vào đó, hãy chỉ định một cấp phiên bản, chẳng hạn như "Bazel X.x trở lên hỗ trợ <feature> hoặc một đường liên kết đến vấn đề trên GitHub.

• Có: Bazel 0.10.0 trở lên hỗ trợ tính năng lưu vào bộ nhớ đệm từ xa.
• Không: Bazel sẽ sớm hỗ trợ tính năng lưu vào bộ nhớ đệm từ xa, có thể là vào tháng 10 năm 2017.

Tense

• Sử dụng thì hiện tại. Tránh dùng thì quá khứ hoặc tương lai, trừ phi thực sự cần thiết để làm rõ.

  • Có: Bazel sẽ đưa ra lỗi khi tìm thấy các phần phụ thuộc không tuân thủ quy tắc này.
  • Không: Nếu Bazel tìm thấy một phần phụ thuộc không tuân thủ quy tắc này, Bazel sẽ đưa ra lỗi.

• Nếu có thể, hãy sử dụng câu chủ động (trong đó chủ ngữ tác động lên tân ngữ) chứ không phải câu bị động (trong đó tân ngữ chịu tác động của chủ ngữ). Nhìn chung, dạng chủ động giúp câu rõ ràng hơn vì cho biết ai chịu trách nhiệm. Nếu việc sử dụng câu chủ động làm giảm độ rõ ràng, hãy sử dụng câu bị động.

  • Có: Bazel khởi động X và dùng đầu ra để tạo Y.
  • Không: X được Bazel khởi tạo, sau đó Y sẽ được tạo bằng đầu ra.

Giọng điệu

Viết bằng giọng điệu thân thiện với doanh nghiệp.

• Tránh sử dụng ngôn ngữ thông tục. Khó dịch những cụm từ dành riêng cho tiếng Anh.

  • Có: Bộ quy tắc tốt
  • Không: Vậy bộ quy tắc hiệu quả là gì?

• Tránh sử dụng ngôn ngữ quá trang trọng. Hãy viết như thể bạn đang giải thích khái niệm này cho một người tò mò về công nghệ nhưng không biết chi tiết.

Định dạng

Loại tệp

Để dễ đọc, hãy ngắt dòng ở 80 ký tự. Đường liên kết hoặc đoạn mã dài có thể dài hơn, nhưng phải bắt đầu trên một dòng mới. Ví dụ:

Liên kết

• Sử dụng câu chữ mô tả trong đường liên kết thay vì "tại đây" hoặc "bên dưới". Phương pháp này giúp bạn dễ dàng quét tài liệu và phù hợp hơn với trình đọc màn hình.

  • Có: Để biết thêm thông tin, hãy xem phần [Cài đặt Bazel].
  • Không: Để biết thêm thông tin, hãy xem [tại đây].

• Kết thúc câu bằng đường liên kết (nếu có thể).

  • Có: Để biết thêm thông tin, hãy xem [link].
  • Không: Xem [link] để biết thêm thông tin.

Danh sách

• Sử dụng danh sách có thứ tự để mô tả cách hoàn thành một nhiệm vụ theo các bước
• Sử dụng danh sách không có thứ tự để liệt kê những việc không phải là việc cần làm. (Vẫn phải có một thứ tự nào đó, chẳng hạn như theo bảng chữ cái, mức độ quan trọng, v.v.)
• Viết theo cấu trúc song song. Ví dụ:
  1. Biến tất cả các mục trong danh sách thành câu.
  2. Bắt đầu bằng các động từ có cùng thì.
  3. Sử dụng danh sách có thứ tự nếu có các bước cần làm theo.

Phần giữ chỗ

• Sử dụng dấu ngoặc nhọn để biểu thị một biến mà người dùng nên thay đổi. Trong Markdown, hãy thoát dấu ngoặc nhọn bằng dấu gạch chéo ngược: \<example\>.

  • Có: bazel help <command>: Trợ giúp và các lựa chọn in cho <command>
  • Không: bazel help command: In thông tin trợ giúp và các lựa chọn cho "command"

• Đặc biệt đối với các mẫu mã phức tạp, hãy sử dụng các phần giữ chỗ có ý nghĩa trong ngữ cảnh.

Mục lục

Sử dụng mục lục được tạo tự động mà trang web hỗ trợ. Không thêm mục lục theo cách thủ công.

Mã

Đoạn mã mẫu là người bạn thân nhất của nhà phát triển. Có lẽ bạn đã biết cách viết những nội dung này, nhưng sau đây là một vài mẹo.

Nếu đang tham chiếu một đoạn mã nhỏ, bạn có thể nhúng đoạn mã đó vào một câu. Nếu bạn muốn người đọc sử dụng mã, chẳng hạn như sao chép một lệnh, hãy sử dụng một khối mã.

Khối mã

• Tạo nội dung ngắn gọn. Loại bỏ tất cả văn bản dư thừa hoặc không cần thiết khỏi mẫu mã.
• Trong Markdown, hãy chỉ định loại khối mã bằng cách thêm ngôn ngữ của mẫu.

```shell
...

• Phân tách các lệnh và đầu ra thành các khối mã riêng biệt.

Định dạng mã trong dòng

• Sử dụng kiểu mã cho tên tệp, thư mục, đường dẫn và các đoạn mã nhỏ.
• Sử dụng kiểu mã cùng dòng thay vì chữ in nghiêng, "dấu ngoặc kép" hoặc chữ in đậm.
  • Có: bazel help <command>: Trợ giúp và các lựa chọn in cho <command>
  • Không: bazel help command: In thông tin trợ giúp và các lựa chọn cho "command"