💼 Người đi làm›cho dân IT Ngữ pháp·Trung cấp
IT: Viết bug report rõ ràng: các bước tái hiện, kết quả mong đợi
Hướng dẫn cách sử dụng câu mệnh lệnh cho các bước tái hiện lỗi và thì hiện tại đơn cho kết quả mong đợi/thực tế trong báo cáo lỗi phần mềm.
1. Tình huống thực tế
Hãy cùng xem xét đoạn văn ngắn dưới đây trích từ một báo cáo lỗi (bug report) trong dự án phần mềm:
First, navigate to the checkout page and click 'Pay Now'. The payment screen becomes unresponsive, preventing the user from completing the transaction. While the expected outcome is a successful payment confirmation, the actual behavior is a blank screen. This inconsistency occurs only when using credit cards.
Phân tích ngữ pháp & từ vựng trong đoạn:
- navigate to... / click...: Các câu mệnh lệnh (Imperative) dùng động từ nguyên mẫu đứng đầu câu để chỉ dẫn các bước tái hiện.
- becomes / is / occurs: Thì Hiện tại đơn (Present Simple) diễn tả trạng thái và quy trình hoạt động thực tế của ứng dụng.
- While the expected outcome is..., the actual behavior is...: Cấu trúc đối lập giữa kết quả mong đợi và kết quả thực tế.
2. Ngữ pháp & Cấu trúc viết Bug Report chuẩn
a. Cấu trúc câu Mệnh lệnh (Imperative Sentences) cho Steps to Reproduce
Để viết phần Steps to Reproduce (Các bước tái hiện) ngắn gọn, chuyên nghiệp, hãy bắt đầu mỗi bước bằng một động từ nguyên mẫu không 'to' (V-bare). Tránh dùng các từ nối rườm rà hoặc xưng I / You.
- Cấu trúc: [Verb-bare] + [Object/Component] + [Details]
- Ví dụ: Open the mobile application on Android 14. (Mở ứng dụng di động trên Android 14.)
- Ví dụ: Select any product and add it to the cart. (Chọn bất kỳ sản phẩm nào và thêm vào giỏ hàng.)
b. Cấu trúc diễn đạt Expected Result vs Actual Result
Khi mô tả kết quả mong đợi (Expected Result) và kết quả thực tế (Actual Result), thì Hiện tại đơn là sự lựa chọn tiêu chuẩn vì nó phản ánh quy trình/sự thật khách quan của phần mềm.
| Mục tiêu | Cấu trúc khuyên dùng | Ví dụ |
|---|---|---|
| Expected Result | System + V(s/es) + Object | The app sends an OTP code via SMS. (Ứng dụng gửi mã OTP qua SMS.) |
| Actual Result | System + V(s/es) / adj | The system displays a 500 internal server error. (Hệ thống hiển thị lỗi máy chủ 500.) |
| Mô tả đối lập | While [Expected], [Actual] | While the app should navigate to Home, it remains unresponsive. (Trong khi ứng dụng nên chuyển về Trang chủ, nó lại không phản hồi.) |
3. Lưu ý lỗi người Việt hay mắc phải (Common Vietnamese Mistakes)
- Kể chuyện thay vì ra chỉ dẫn: Người học thường viết 'I open the app and then I clicked button' thay vì dùng câu mệnh lệnh ngắn gọn 'Open the app and click the button'.
- Lạm dụng thì Quá khứ đơn: Dùng Past Simple (ví dụ: 'The app crashed') khi mô tả Actual Result. Hãy ưu tiên Present Simple ('The app crashes' hoặc 'The app displays an error') để thể hiện lỗi hiện tại của hệ thống.
- Dịch xuôi từ tiếng Việt: Viết 'The screen is black' thay vì sử dụng thuật ngữ chuyên ngành chuẩn như 'The application displays a blank screen'.
4. Bài tập thực hành (Practice)
Hãy chọn câu đúng nhất để mô tả bước tái hiện lỗi:
- Câu 1: (A) You need to click on the Save button. / (B) Click the 'Save' button. -> Đáp án đúng là B (Sử dụng mệnh lệnh thức trực tiếp).
- Câu 2: (A) While the system should show a success message, it freezes. / (B) The system should show success message but it frozen. -> Đáp án đúng là A (Sử dụng cấu trúc đối lập chuẩn ngữ pháp).
5. Tóm tắt bài học
Để viết bug report chuyên nghiệp: Dùng động từ nguyên mẫu cho các bước thực hiện, dùng thì Hiện tại đơn cho kết quả thực tế/mong đợi, và giữ câu văn ngắn gọn, đi thẳng vào vấn đề.
