Tense tata bahasa apa yang harus saya tulis spesifikasi saya?

21

Kami sedang menulis spesifikasi fungsional dan teknis dalam format dua kolom; kalimat ringkasan dan detail teknis. Detail sering merujuk pada lampiran dengan diagram, desain tata letak dll.

Namun saya berjuang dengan apa yang tegang untuk menuliskannya di:

Dengan lampau seolah-olah pekerjaan itu dilakukan saya berjuang untuk menunjukkan ekstensi menyoroti pekerjaan yang keluar. Future tense seperti di dalamnya perlu dilakukan X mulai terdengar seperti to do list atau Tense netral yang sangat sulit karena akan dilakukan atau dilakukan.

Untuk menambah kebingungan lebih lanjut spesifikasi ini dapat dibaca oleh orang-orang yang tidak memiliki bahasa Inggris sebagai bahasa pertama.

documentation specifications writing

— John
sumber

12

Kami punya banyak hal di tempat kerja terakhir saya.

Manajer produk telah memilih untuk menggunakan present tense untuk menggambarkan apa yang harus dilakukan , seperti:

Pengguna mengirimkan pesanan. Sistem mengirim pesan konfirmasi.

Sayangnya deskripsi prasyarat juga dilakukan dalam present tense, seperti:

Pengguna memasukkan barang ke dalam keranjang belanja dan menentukan jumlahnya.

Ini telah menyebabkan banyak kebingungan bagi saya karena tidak jelas apa yang sudah ada dan apa yang akan datang. Saya sudah mencoba membuat mereka menggunakan bentuk masa depan tetapi mereka tidak pernah berubah. Secara pribadi, saya tidak bisa terbiasa dengan itu selama dua tahun saya di sana. Itu tidak masuk akal, terdengar seperti seseorang tidak memiliki penguasaan bentuk bahasa.

Karena itu:

Gunakan present tense untuk apa yang sudah ada
Gunakan bentuk waktu mendatang untuk apa yang harus dilakukan. Mempekerjakan dunia "harus", "harus", "akan".

Langkah penting untuk diingat adalah meninjau kembali spesifikasi. Pastikan untuk memperbarui kata-kata dari masa depan hingga saat ini selesai.

— Ben L

@ Ben: Tidak, itu salah. Bentuknya digunakan untuk bagaimana memberikan implementasi yang benar, bukan untuk menunjukkan status implementasi. Di sini, future tense digunakan untuk menunjukkan keadaan aplikasi di masa depan, bukan kondisi implementasi di masa depan. Selain itu, perlu dicatat bahwa pendekatan yang dianjurkan di sini juga digunakan oleh sebagian besar RFC. Lihat RFC 2119 untuk diskusi tentang persyaratan harus / wajib / harus (tidak), harus / direkomendasikan (tidak), dan mungkin / opsional.

— Brian

5

Present tense sepertinya baik untuk saya.

Prasyarat: Foo dalam keadaan X
Operasi: ini dan itu terjadi
Postcondition: Foo dalam keadaan Y

semua itu ada dalam present tense.

Atau jika itu adalah "keadaan proyek"

Versi 10: memiliki fitur A, B, C dan D
Versi 10.1: berisi peningkatan ke A. Perbaikan bug 1049 di B. Menambahkan fitur baru E.

— Uang tunai
sumber

3

Anda mungkin ingin tahu apa praktik menulis RFC.

Ini adalah RFC 2119: Kata-kata kunci untuk digunakan dalam RFC untuk Menunjukkan Tingkat Kebutuhan .

— mouviciel
sumber

3

bagaimana ini menjawab pertanyaan yang diajukan?

— nyamuk

1

Selain itu, ini adalah jawaban tautan saja.

— Kromster mengatakan mendukung Monica

2

spesifikasi adalah instruksi. tuliskan dalam present tense. seperti ini.

— Steven A. Lowe
sumber

1

Ketika saya membuat desain untuk perangkat lunak, saya menyukai present tense, bahkan jika saya membuat desain sebelum perangkat lunak itu ada. Bahkan setelah aplikasi perangkat lunak diimplementasikan dari desain, desain dokumen masih relevan dan penting. Sangat mungkin bahwa dokumen desain mungkin tetap relevan untuk periode waktu yang lebih lama setelah perangkat lunak diimplementasikan daripada sebelum diimplementasikan.

— Dan Stevens
sumber