Spesifikasi teknikal (spesifikasi teknologi) adalah dokumen yang menerangkan apa yang akan dilakukan oleh produk atau projek dan bagaimana anda akan mencapai matlamat ini. Dalam spesifikasi teknologi, tunjukkan kepada pelanggan dan ahli pasukan anda apa masalah yang anda selesaikan, tujuan atau keperluan untuk projek atau produk anda, dan bagaimana anda merancang untuk mencapainya. Spesifikasi teknologi mengarahkan kerja itu diselesaikan, dan anda biasanya akan menulisnya semula semasa projek anda berjalan.
Langkah-langkah
Bahagian 1 dari 3: Menulis Tajuk Anda
Langkah 1. Letakkan nama projek di bahagian atas menggunakan fon serif 14-pt atau 16-pt
Ini adalah nama produk anda atau tajuk projek itu sendiri. Gunakan fon sans serif dalam 14-pt atau 16-pt sehingga senang dibaca. Kiri membenarkannya atau pusat membenarkannya, bergantung pada pilihan anda.
Tempat kerja atau tenaga pengajar anda mungkin menyediakan templat yang menunjukkan cara menulis tajuk anda. Sentiasa ikuti templat jika ada
Adakah kamu tahu?
Font sans serif tidak mempunyai garis akhir pada huruf, jadi gaya ini mempunyai penampilan yang lebih moden. Fon sans serif yang paling popular ialah Arial, Calibri, dan Verdana.
Langkah 2. Tulis tarikh di bawah nama projek dalam fon 12-pt sans serif
Pergi ke baris seterusnya dan kurangkan saiz fon anda menjadi 12-pt. Gunakan fon sans serif yang sama dengan yang anda gunakan untuk menulis nama projek anda. Kemudian, taipkan tarikh menggunakan bulan, hari, dan tahun.
- Sekiranya templat anda berbeza, format tarikh anda mengikut templat.
- Penting untuk memasukkan tarikh supaya anda dapat mengetahui spesifikasi teknologi mana yang paling baru.
Langkah 3. Ketik "Pengarang" dan nama pengarang pada tarikh
Pergi ke baris seterusnya dan tulis "Pengarang" diikuti dengan titik dua. Kemudian, masukkan nama anda kerana anda yang menulis spesifikasi teknikal. Sentiasa meletakkan nama anda sahaja, walaupun anda membincangkan kandungan spesifikasi teknologi anda dengan pasukan.
Spesifikasi teknologi selalu memerlukan satu pengarang, walaupun anda bekerja dengan satu pasukan. Penulis adalah orang yang betul-betul menaip spesifikasi
Langkah 4. Letakkan "Pasukan" dan nama ahli pasukan terakhir
Pada baris seterusnya, ketik "Pasukan", diikuti dengan titik dua. Kemudian, tuliskan nama setiap ahli pasukan yang mengusahakan projek atau produk tersebut.
- Selain memberi penghargaan kepada ahli pasukan anda, ini membantu orang memahami siapa mereka boleh pergi jika mereka mempunyai pertanyaan mengenai spesifikasi teknologi.
- Sekiranya anda bekerja sendiri dalam projek ini, langkau langkah ini.
Bahagian 2 dari 3: Merangka Spesifikasi Teknikal
Langkah 1. Berikan gambaran keseluruhan atau ringkasan ringkas mengenai projek atau produk
Mulakan spesifikasi teknologi anda dengan ringkasan tentang apa yang anda lakukan. Ketik "Ikhtisar" atau "Ringkasan Ringkas" sebagai tajuk anda. Terangkan masalahnya, kemudian ringkaskan apa itu projek atau produk dan apa yang akan dilakukannya. Seterusnya, terangkan bagaimana pendekatan anda untuk mencapainya dan sertakan spesifikasi produk jika ia adalah peralatan. Pautan ke mana-mana dokumen pemasaran atau kejuruteraan yang penting untuk projek ini. Akhirnya, berikan anggaran masa yang sukar untuk berapa lama masa yang diperlukan untuk menyelesaikan projek atau produk.
Anda mungkin menulis, "Sistem saat ini untuk merencanakan perjalanan transit di seluruh daerah membuat para penunggang terdampar dan menurunkan penunggang pada laluan tertentu. Dua sistem bas membolehkan penunggang merancang perjalanan mereka dalam talian, tetapi yang ketiga menggunakan peta kertas dan hubungan telefon. Penyelesaian ini adalah menurunkan jumlah penumpang dan menyebabkan kekurangan dana, lihat hasil tinjauan Spring 2019. Kami ingin memindahkan semua 3 jalur transit ke 1 sistem perancangan yang boleh diakses oleh pengguna dalam talian. Ini akan membolehkan mereka merancang perjalanan dengan lebih mudah dan melihat kapan bas akan berada di setiap perhentian. Selain itu, pengendara dapat melaporkan masalah dengan segera menggunakan fungsi 'hubungi kami'. "
Langkah 2. Sertakan bahagian matlamat jika tidak terdapat dalam gambaran keseluruhan atau ringkasan ringkas
Ketik "Matlamat" sebagai tajuk, kemudian gariskan secara ringkas apa yang anda rancangkan untuk dicapai dengan projek atau produk anda. Tulis pernyataan pendahuluan, kemudian senaraikan matlamat anda dalam senarai bernombor atau bulet.
- Sekiranya anda menggariskan matlamat anda di bahagian ikhtisar, biasanya anda tidak memerlukan bahagian ini. Walau bagaimanapun, anda mungkin diminta untuk memasukkan bahagian ini jika tempat kerja anda memerlukannya.
- Tulis sesuatu seperti, "Sistem baru akan merangkumi: 1) Alat perancangan laluan; 2) Fungsi pencari bas; 3) Cara penunggang melaporkan masalah. "
Langkah 3. Tulis keperluan produk di bahagian yang berasingan
Seterusnya, ketik "Keperluan Produk" sebagai tajuk, diikuti dengan perkara yang perlu dilakukan oleh produk anda untuk menyelesaikan masalah anda. Gunakan senarai peluru dan jangan bimbang tentang ayat pendahuluan.
Contohnya, “1) Perancang laluan memastikan penunggang tidak terkandas dan bas tidak dimanfaatkan dengan baik; 2) Kotak hubungan membolehkan perancang transit bertindak balas secara langsung terhadap masalah penunggang. "
Langkah 4. Terangkan perkara yang berada di luar ruang lingkup projek anda
Judul bahagian ini "Di Luar Skop" atau "Bukan Sasaran." Jangan tulis petunjuk atau perenggan. Sebaliknya, buat senarai peluru perkara yang tidak akan anda lakukan untuk menyelesaikan masalah anda. Ini termasuk kerja yang tidak akan anda lakukan, penyelesaian yang anda rasa tidak akan berfungsi, dan atribut produk atau projek anda tidak akan ada. Bersikap teliti agar pelanggan dan pasukan anda tidak mempunyai salah faham.
Anda mungkin menulis, “1) Sistem ini tidak akan menambah laluan bas baru; 2) Kami tidak akan memasang komputer di perhentian bas atau bas, jadi penunggang perlu menggunakan peranti mereka sendiri; 3) Perancang transit tidak akan menjamin penyelesaian segera terhadap masalah penunggang; dan 4) Perkhidmatan ini tidak termasuk pengambilan dari pintu ke pintu. "
Variasi:
Kadang-kadang bahagian ini diletakkan berhampiran hujung spesifikasi teknologi sebelum garis masa. Gunakan penempatan pilihan anda atau buat perkara yang paling biasa di tempat kerja anda.
Langkah 5. Sertakan bahagian "Pertanyaan Terbuka" jika anda mempunyai masalah yang tidak dapat diselesaikan
Spesifikasi teknologi anda adalah garis besar produk atau projek sehingga pelanggan anda memahami apa yang mereka dapatkan dan pasukan anda berusaha mencapai tujuan yang sama. Jangan bimbang untuk menyertakan setiap perincian atau menjawab soalan "anda harus ditentukan". Sebagai gantinya, taip tajuk "Pertanyaan Terbuka" dan tunjukkan senarai butir perkara yang akan anda putuskan kemudian.
Tulis, “1) Bagaimana kita menguruskan kemas kini sistem? 2) Adakah kita akan menukar peta laluan sekiranya kita menemui masalah? 3) Bolehkah sistem ini melayani penunggangan berbilang bahasa tanpa kesalahan terjemahan? 4) Bagaimanakah cara terbaik untuk melayani pengendara yang tidak mahir teknologi? "
Langkah 6. Kemukakan rancangan anda di bahagian "Pendekatan"
Judul bahagian ini sama ada "Rencana" atau "Pendekatan". Jelaskan bagaimana anda akan menyelesaikan masalah atau pendekatan berbeza yang anda pertimbangkan jika keputusan akhir belum dibuat. Terangkan penyelidikan anda dan setiap teknologi atau proses yang akan anda gunakan. Sekiranya boleh, sertakan ilustrasi, carta, dan diagram sehingga memudahkan pembaca anda memahami rancangan anda. Akhirnya, bincangkan bagaimana anda akan menguji rancangan anda dan apa yang akan anda lakukan sekiranya terdapat masalah.
- Sekiranya anda menerangkan pendekatan atau teknologi yang berbeza, buatlah subseksyen untuk masing-masing supaya rancangan anda mudah diikuti.
- Tulislah seperti, "Kami akan bekerjasama dengan pasukan perencanaan transit untuk merancang perisian yang membolehkan penunggang memasukkan destinasi mereka ke dalam aplikasi yang akan menghasilkan laluan untuk mereka. Penunggang kemudian boleh mengubah laluan jika mereka mahu. Sistem akan menghantar kemas kini teks kepada penunggang untuk membantu mereka mencari jalan mereka. Kami akan meminta penunggang di jawatankuasa pemangku kepentingan menguji perisian tersebut sebelum kami membebaskannya kepada umum. Sekiranya rancangan itu mempunyai kesilapan, kami akan membuat kemas kini laman web pada waktu-waktu ketika bas tidak beroperasi. Selain itu, kami akan menyediakan bas ulang-alik tambahan untuk menjemput penumpang yang terkandas kerana sistem. "
Variasi:
Anda mungkin memasukkan bahagian "Komponen" di bahagian atas untuk meringkaskan apa yang diperlukan oleh rancangan atau pendekatan anda. Walau bagaimanapun, ini biasanya pilihan, kecuali syarikat atau tenaga pengajar anda memerlukannya.
Langkah 7. Sertakan pilihan lain yang anda pertimbangkan tetapi dikesampingkan
Letakkan bahagian ini sebagai titik bawah dalam rancangan atau pendekatan anda atau letakkan di hujung spesifikasi anda sebelum garis masa anda. Ketik tajuk "Pilihan Lain Yang Dipertimbangkan", kemudian jelaskan alternatif yang anda pertimbangkan sebelum anda memilih rancangan semasa anda. Terangkan mengapa anda menolak setiap pilihan.
Anda mungkin menulis, "Kami menganggap peta berkod warna kerana ini adalah pilihan yang lebih murah, tetapi penunggang tidak memberi respons yang baik terhadap peta yang ada dan kumpulan ujian menjadi bingung."
Langkah 8. Huraikan kaedah dan metrik anda untuk menilai produk atau projek
Sertakan maklumat ini dalam satu bahagian atau beberapa bahagian. Judulnya seperti "Mengukur Kesan" atau "Pemantauan" dan "Metrik." Dalam satu atau lebih perenggan, terangkan bagaimana anda akan memastikan produk atau projek anda berfungsi dengan betul dan mencapai matlamat anda. Selain itu, terangkan bagaimana anda akan memeriksa pepijat atau masalah.
- Sertakan proses analisis atau teknologi khusus yang akan anda gunakan.
- Katakan sesuatu seperti, "Kami akan membandingkan masa laluan yang diproyeksikan dengan masa laluan yang sebenarnya untuk memastikan bas mengikut jadual. Selain itu, kami akan melakukan tinjauan penunggang untuk menilai kepuasan mereka dan mengenal pasti masalah dengan sistem. "
Langkah 9. Kenal pasti bagaimana anda akan memberikan keselamatan dan privasi
Ketik tajuk "Keselamatan dan Privasi", kemudian jelaskan bagaimana anda akan melindungi pengguna dari serangan siber. Huraikan secara ringkas risiko dan bagaimana anda akan melindungi sistem anda sehingga privasi dilindungi. Tulis beberapa perenggan untuk menerangkan kaedah anda.
- Selalu ada risiko atau kebimbangan, jadi jangan letakkan "tidak ada risiko" di bahagian ini.
- Anda mungkin menulis, "Pengguna akan memasukkan lokasi dan alamat rumah mereka. Selain itu, mereka akan mempunyai pilihan untuk membuat profil dan menyimpan perjalanan. Untuk melindungi data ini, kami akan menyertakan enkripsi dan firewall. "
Langkah 10. Selesaikan dengan garis masa dan senarai tonggak
Garis masa membantu memastikan projek anda tetap berjalan dan memberitahu pelanggan dan pasukan anda apa yang perlu dilakukan. Judul bahagian ini "Garis Masa", kemudian pecahkan tugas mengikut siapa yang melakukannya. Sertakan senarai peluru untuk setiap pasukan atau ahli pasukan, bergantung pada pilihan anda.
- Misalnya, perincian tugas anda mungkin menyenaraikan "Tim Kejuruteraan", "Pasukan Perancangan", "Pemasaran", dan "Jaminan Kualiti".
- Daftar peluru anda untuk pasukan kejuruteraan mungkin merangkumi tugas seperti, “1) Tulis peningkatan laman web; 2) Tulis aplikasi perancangan perjalanan; 3) Tulis sistem hubungan. "
Bahagian 3 dari 3: Menyelesaikan Spesifikasi Teknikal Anda
Langkah 1. Letakkan satu ruang dokumen anda dan langkau 1 baris antara bahagian
Gunakan jarak tunggal supaya spesifikasi teknologi anda lebih pendek dan lebih mudah dikendalikan. Apabila anda mahu menukar perenggan atau bahagian, langkau 1 baris. Ini membantu pembaca mengikuti tanpa menambahkan halaman yang tidak diperlukan.
Tempat kerja atau pengajar anda mungkin memberi anda arahan format yang berbeza. Sekiranya ada, ikuti arahan ini
Langkah 2. Gunakan sudut pandang orang pertama di seluruh spesifikasi teknologi anda
Oleh kerana anda membincangkan kerja yang akan anda dan pasukan anda lakukan, selalu gunakan kata ganti nama orang pertama "Saya," "saya," "kita," dan "kita." Semasa anda merujuk kepada pasukan atau orang tertentu, gunakan namanya sehingga jelas siapa yang anda bicarakan. Ini memastikan spesifikasi teknikal terus dan tepat kerana pembaca tahu bagaimana menyelesaikan setiap tindakan.
- Misalnya, katakanlah, "Kami akan memperbarui spesifikasi sesuai kebutuhan" dan bukan "Spesifikasi akan diperbarui sesuai kebutuhan."
- Begitu juga, tulis "Pasukan kejuruteraan akan menulis laman web" atau "Amy akan merangka rancangan pemasaran."
Langkah 3. Tulis teks yang jelas dan ringkas yang mudah diikuti
Jangan huraikan idea anda dalam spesifikasi teknologi kerana ia membuang masa anda dan masa pembaca anda. Gunakan sesedikit mungkin perkataan untuk mengekspresikan idea anda dan mengatur pemikiran anda agar mudah diikuti. Teliti laporan anda dan hapuskan kata-kata yang tidak perlu dan ayat yang berulang sehingga laporan anda lebih tepat.
Sebagai contoh, anda dapat menyemak "Kami akan menulis laman web yang membolehkan penunggang merancang perjalanan yang diinginkan dan memantau bas" hingga "Laman web ini membolehkan perancangan perjalanan dan pelacakan bas."
Langkah 4. Dapatkan pasangan untuk mengkaji spesifikasi teknologi anda dan memberikan maklum balas
Kongsi spesifikasi teknologi anda dengan ahli pasukan atau rakan sekelas yang akan memahaminya. Mintalah mereka untuk menandakan kesilapan yang mereka lihat dan beri anda maklum balas di mana anda boleh membuat penambahbaikan.
Jangan tunjukkan spesifikasi teknologi anda kepada seseorang yang tidak memahami bidang anda. Mereka mungkin keliru dan mungkin mengesyorkan perubahan yang tidak diperlukan
Langkah 5. Semak semula spesifikasi teknologi anda sekiranya diperlukan perubahan
Berdasarkan maklum balas yang anda terima, kunjungi kembali spesifikasi teknikal anda dan buat semakan sekiranya anda merasa perlu. Fokus untuk menjadikan spesifikasi teknologi dapat difahami oleh pelanggan dan pasukan anda. Namun, jangan bimbang ia tidak sempurna.
Anda mungkin perlu mengemas kini spesifikasi teknologi anda semasa projek atau produk anda berjalan. Ini adalah dokumen sementara, jadi jangan biarkan ia menghalang anda melakukan kerja sebenar
Langkah 6. Proofread spesifikasi teknologi anda sebelum anda menyebarkannya
Baca spesifikasi teknologi anda sekurang-kurangnya dua kali untuk memeriksa kesilapan. Sekiranya anda boleh, bacalah dengan kuat untuk membantu anda menangkap kesilapan anda. Fokus pada perkara seperti kesalahan ketik atau perkataan yang mungkin mengubah makna dokumen anda.