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

Báo cáo vấn đề Xem nguồn Nightly/3}

Cảm ơn bạn đã đóng góp tài liệu cho Bazel. Đây là hướng dẫn nhanh về quy tắc lập trình để giúp bạn bắt đầu. Đối với mọi thắc mắc về kiểu không có trong hướng dẫn này, hãy làm theo Hướng dẫn về quy tắc lập trình cho tài liệu dành cho nhà phát triển của Google.

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

Các tài liệu về 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ể.
  • Rõ ràng. Sử dụng ngôn từ đơn giản. Viết mà không có biệt ngữ đối với cấp độ đọc lớp năm.
  • Nhất quán. Hãy dùng cùng một từ hoặc cụm từ cho các khái niệm lặp lại trong suốt tài liệu.
  • Chính xác. Viết theo cách mà nội dung luôn chính xác lâu nhất có thể bằng cách tránh thông tin theo thời gian và lời hứa cho tương lai.

Viết

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

Tiêu đề

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

  • Tạo tiêu đề ngắn gọn ở mức hợp lý. Bằng cách này, các chế độ xem này vừa với MPEG mà không cần gói.

    • Có: Quyền
    • Không: Lưu ý ngắ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

  • Hãy cố gắng tạo tiêu đề dựa trên nhiệm vụ hoặc khả thi. Nếu tiêu đề chỉ 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 ghi vào hành động của người dùng.

    • Có: Thứ tự bảo tồn trong biểu đồ
    • Không: Về việc lưu giữ thứ tự biểu đồ

Tên

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

    • Có: Khi tạo xong, Bazel sẽ in các mục tiêu được yêu cầu.
    • No (Không): Khi tạo xong, bazel sẽ in các mục tiêu được yêu cầu.

  • Đảm bảo tính nhất quán. Không sử dụng tên mới cho các khái niệm hiện có. Nếu có thể, hãy sử dụng thuật ngữ được định nghĩa trong Bảng thuật ngữ.

    • Ví dụ: nếu bạn đang viết về việc tạo 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 nên có một mục đích và nên được xác định ngay từ đầu. Cách này giúp độc giả tìm thấy nội dung họ cần nhanh hơn.

    • Có: Trang này hướng dẫn 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 các 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, ví dụ tương tự hoặc các cách khác để khám phá.

Tiêu đề

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

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

    • Yes (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: Để người dùng tạo mã Java bằng Bazel, họ 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 nhà duy trì, người đóng góp, người di chuyển hoặc các vai trò khác.

  • Tránh sử 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 điều có thể xảy ra.

    • 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 một số thay đổi đối với Bazel. Đôi khi, Bazel 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.

Thời gian

Nếu có thể, hãy tránh dùng các từ ngữ có thể định hướng thời gian, chẳng hạn như đề cập đến các ngày cụ thể (quý 2 năm 2022) hoặc nói "hiện tại", "hiện tại" hoặc "sớm". Các hình ảnh này sẽ nhanh chóng lỗi thời và có thể không chính xác nếu đó là hình chiếu 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 đường liên kết đến vấn đề trên GitHub.

  • Có: Bazel 0.10.0 trở lên hỗ trợ chức 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ể vào tháng 10 năm 2017.

Tense

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

    • Có: Bazel đư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.
    • No (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, thì Bazel sẽ đưa ra thông báo lỗi.

  • Nếu có thể, hãy dùng giọng nói chủ động (khi một đối tượng hành động dựa trên một đối tượng) thay vì dùng giọng nói thụ động (trong đó một đối tượng được đối tượng hành động). Nhìn chung, giọng nói chủ động sẽ giúp các câu rõ ràng hơn vì nó cho biết ai có trách nhiệm. Nếu việc sử dụng câu chủ động làm giảm sự rõ ràng, hãy sử dụng thể bị động.

    • Có: Bazel khởi tạo X và sử dụng đầu ra để tạo Y.
    • No (Không): X do Bazel khởi tạo, sau đó Y sẽ được tạo với dữ liệu đầu ra.

Giọng điệu

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

  • Tránh ngôn từ thông tục. Sẽ khó dịch hơn các cụm từ dành riêng cho tiếng Anh.

    • Có: Quy tắc phù hợp
    • Không: Vậy bộ quy tắc hiệu quả là gì?

  • Tránh dùng ngôn từ trang trọng quá mức. 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 gói các dòng ở mức 80 ký tự. Các 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ụ:

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

    • Có: Để biết thêm chi tiết, hãy xem phần [Cài đặt Bazel].
    • Không: Để biết thêm chi tiết, 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 chi tiết, hãy xem [link].
    • Không: Hãy xem [link] để biết thêm thông tin.

Danh sách

  • Sử dụng danh sách theo thứ tự để mô tả cách hoàn thành một tác vụ theo các bước
  • Sử dụng danh sách không theo thứ tự để liệt kê những nội dung không dựa trên tác vụ. (Vẫn cần sắp xếp theo thứ tự, chẳng hạn như bảng chữ cái, mức độ quan trọng, v.v.)
  • Viết có cấu trúc song song. Ví dụ:
    1. Tạo tất cả các câu của mục trong danh sách.
    2. Bắt đầu với 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 thực hiện.

Phần giữ chỗ

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

    • Có: bazel help <command>: In thông tin trợ giúp và tuỳ chọn cho <command>
    • Không: lệnh trợ giúp bazel: In trợ giúp và các tuỳ chọn cho "command"

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

Mục lục

Hãy sử dụng MPEG được tạo tự động mà trang web này hỗ trợ. Đừng thêm hoạch thu nhập bằng cách thủ công.

Mã

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

Nếu bạn đang tham chiếu một đoạn mã nhỏ, bạn có thể nhúng đoạn mã đó trong một câu. Nếu bạn muốn trình đọc sử dụng mã, chẳng hạn như sao chép lệnh, hãy dùng 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 thừa hoặc không cần thiết khỏi một mã mẫu.
  • 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 nhiều khối mã.

Định dạng mã cùng 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ì in nghiêng, "dấu ngoặc kép" hoặc in đậm.
    • Có: bazel help <command>: In thông tin trợ giúp và tuỳ chọn cho <command>
    • Không: lệnh trợ giúp bazel: In trợ giúp và các tuỳ chọn cho "command"