Việc tuân theo các nguyên tắc về ngữ pháp, dấu chấm câu và cách viết giúp cho bài trình bày của chúng tôi thống nhất. Người dùng sẽ có trải nghiệm tốt hơn nếu họ biết what nên mong đợi gì và where nơi tìm thông tin cần thiết.
Cơ bản
- Be democratic . Một số người đọc từng từ; một số người quét qua và tìm kiếm hoặc thích xem video. Hãy giúp mọi người.
- Be focused. Hãy đưa thông tin quan trọng nhất lên đầu câu, đoạn văn, và phần.
- Be concise. Sử dụng ngôn ngữ đơn giản và câu vắn tắt.
- Be consistent. Tuân theo các nguyên tắc và mẹo về cách viết bên dưới.
- Be specific. Hãy truyền đạt thông tin rõ ràng bằng cách sử dụng ít từ và từ đơn giản hơn mỗi khi có thể.
Hướng dẫn
Chính tả và ngữ pháp
Chúng tôi sử dụng cách viết tiếng Anh theo Merriam-Webster cho tất cả các phần giao tiếp với người dùng.
Always hãy kiểm tra chính tả và ngữ pháp trước khi xuất bản. Các công cụ kiểm tra chính tả được tích hợp sẵn thường gặp trong các chương trình như Google Docs và Microsoft Word . Các nguồn tài nguyên trực tuyến miễn phí bao gồm:
Woo so với WooCommerce
“Woo” là tên công ty và thương hiệu của chúng tôi. “WooCommerce” là tên của plugin thương mại điện tử phổ biến và được yêu thích của chúng tôi cho WordPress (AKA sản phẩm chính của chúng tôi).
Khi nói về công ty hoặc những gì thương hiệu đó đang làm, hãy sử dụng “Woo”. Nhưng khi nói về nền tảng – bất cứ điều gì được thực hiện cụ thể với hoặc trên nền tảng – nó nên là “WooCommerce.”
Lưu ý: Chúng tôi đôi khi sử dụng “Woo” để viết tắt cho “WooCommerce” trong các văn bản giao tiếp ra ngoài. Điều này nên được thực hiện ít thôi, để tránh gây rối loạn giữa thương hiệu và nền tảng.
Viết tắt và từ viết tắt
Viết đầy đủ trong lần đề cập đầu tiên, với viết tắt hoặc từ viết tắt trong ngoặc đơn. Sử dụng phiên bản ngắn trong các lần đề cập sau đó.
- First use: Payment Card Industry Data Security Standard (PCI-DSS)
- Second use: PCI-DSS
Nếu viết tắt hoặc từ viết tắt được biết rộng rãi, hãy sử dụng as is .
- API
- FAQ
- HTML
- PHP
- SQL
- SSL
Active voice
Với active voice, chủ thể performs an action . Với passive voice, một hành động được done to it với chủ thể.