Những gì ngữ pháp tôi nên viết thông số kỹ thuật của tôi trong?

Chúng tôi hiện đang viết các thông số kỹ thuật chức năng và kỹ thuật theo định dạng hai cột; tóm tắt câu và chi tiết kỹ thuật. Các chi tiết thường đề cập đến một phụ lục với sơ đồ, thiết kế bố trí ect.

Tuy nhiên tôi đang vật lộn với những gì căng thẳng để viết nó vào:

Với thì quá khứ như thể công việc đã hoàn thành, tôi đấu tranh để hiển thị các phần mở rộng nổi bật của công việc đang thoát. Thì tương lai như trong nó cần phải làm X bắt đầu nghe giống như một danh sách việc cần làm hoặc Tense trung lập rất khó vì nó sẽ được thực hiện hoặc được thực hiện.

Để thêm sự nhầm lẫn, đặc điểm kỹ thuật này có thể được đọc bởi những người không có tiếng Anh là ngôn ngữ đầu tiên.

Chúng tôi đã có rất nhiều điều đó ở nơi làm việc cuối cùng của tôi.

Các nhà quản lý sản phẩm đã chọn sử dụng thì hiện tại để mô tả những gì phải được thực hiện , như:

Người dùng gửi đơn đặt hàng. Hệ thống gửi tin nhắn xác nhận.

Thật không may, việc mô tả các điều kiện tiên quyết cũng được thực hiện ở thì hiện tại, như:

Người dùng đặt một mặt hàng vào giỏ hàng và chỉ định số lượng.

Điều này đã gây ra nhiều nhầm lẫn cho tôi vì không rõ cái gì đã và cái gì sẽ đến. Tôi đã cố gắng làm cho họ sử dụng bất kỳ thì tương lai nhưng họ không bao giờ phải thay đổi. Cá nhân, tôi không thể quen với nó trong cả hai năm ở đó. Nó không có nghĩa gì cả, nghe có vẻ như ai đó đã không làm chủ được các thì của ngôn ngữ.

Vì thế:

• Sử dụng thì hiện tại cho những gì đã tồn tại

• Sử dụng một thì tương lai cho những gì phải được thực hiện. Sử dụng các thế giới "nên", "phải", "sẽ".

Thì hiện tại có vẻ tốt với tôi.

1. Điều kiện tiên quyết: Foo ở trạng thái X
2. Hoạt động: điều này và điều đó xảy ra
3. Hậu điều: Foo ở trạng thái Y

tất cả những thứ đó ở thì hiện tại

Hoặc nếu đó là một "trạng thái của dự án"

1. Phiên bản 10: có tính năng A, B, C và D

2. Phiên bản 10.1: chứa cải tiến về A. Sửa lỗi 1049 trong B. Thêm tính năng mới E.

Bạn có thể muốn biết thực hành viết RFC là gì.

Đây là RFC 2119: Từ khóa để sử dụng trong RFC để chỉ ra các mức yêu cầu .

thông số kỹ thuật là hướng dẫn. viết chúng ở thì hiện tại như thế này.

Khi tôi tạo các thiết kế cho phần mềm, tôi thích thì hiện tại, ngay cả khi tôi tạo các thiết kế trước khi phần mềm tồn tại. Ngay cả sau khi một ứng dụng phần mềm được triển khai từ thiết kế, thiết kế vẫn là tài liệu quan trọng và có liên quan. Hoàn toàn có khả năng một tài liệu thiết kế có thể vẫn còn phù hợp trong thời gian dài hơn sau khi phần mềm được triển khai so với trước khi nó được triển khai.