ข้อกำหนดทางเทคนิคคือเอกสารที่อธิบายสิ่งที่ผลิตภัณฑ์หรือโครงการทำ และแสดงวิธีการบรรลุวัตถุประสงค์ คุณต้องแนะนำลูกค้าและทีมถึงปัญหาที่คุณตั้งใจจะแก้ไข วัตถุประสงค์และความต้องการของผลิตภัณฑ์หรือโครงการ เอกสารอธิบายงานที่ต้องทำและเป็นเรื่องปกติที่จะถูกเขียนใหม่ตลอดการดำเนินการของโครงการ
ขั้นตอน
ส่วนที่ 1 จาก 3: การเขียนชื่อเรื่อง
ขั้นตอนที่ 1 เขียนชื่อโครงการในบรรทัดแรกและในฟอนต์ sans serif ขนาด 14 หรือ 16
ขนาดตัวอักษรควรใหญ่ขึ้นเพื่อให้อ่านง่ายขึ้นและโดดเด่นกว่าข้อความที่เหลือ ปรับชื่อหรือจัดกึ่งกลาง
บริษัทหรือผู้บังคับบัญชาควรจัดให้มีแม่แบบที่แสดงวิธีการเขียนพาดหัวข่าว เมื่อมีเทมเพลตให้ทำตาม
เธอรู้รึเปล่า?
ฟอนต์ Sans serif ไม่มีขีดกลางและส่วนต่อขยายที่ส่วนท้ายของก้านตัวอักษร ทำให้ดูทันสมัยขึ้น ตัวอย่างที่พบบ่อยที่สุดคือ Arial, Calibri และ Verdana
ขั้นตอนที่ 2 เขียนวันที่ด้านล่างชื่อโครงการด้วยฟอนต์ sans serif ขนาด 12
ข้ามบรรทัดและลดขนาดฟอนต์เป็น 12 แต่ไม่ต้องเปลี่ยนฟอนต์ ป้อนวันที่ด้วยวิธีปกติ: วัน x ของเดือน y ของปี z
- หากมีเทมเพลต ให้อ่านเพื่อให้ได้วันที่ในรูปแบบที่ถูกต้อง
- วันที่มีความสำคัญมากเพราะช่วยให้คุณทราบว่าเอกสารเวอร์ชันล่าสุดคืออะไร
ขั้นที่ 3. พิมพ์ “ผู้แต่ง” และชื่อผู้เขียนใต้วันที่
ข้ามบรรทัดอื่นแล้วเขียน "Author" ตามด้วยโคลอน ป้อนชื่อของคุณในขณะที่คุณกำลังจัดทำเอกสาร เพียงแค่ใส่ชื่อของคุณลงไป แม้ว่าผลงานจะเป็นผลจากการสนทนากลุ่มก็ตาม
ข้อกำหนดทางเทคนิคต้องมีผู้เขียนคนเดียวเสมอ แม้ว่าจะเป็นความพยายามของทีมก็ตาม ผู้เขียนคือบุคคลที่เขียนเอกสาร
ขั้นตอนที่ 4. ป้อน “ทีม” และชื่อสมาชิกโครงการ
ในบรรทัดถัดไป ให้เขียน "Team" และโคลอน ระบุรายชื่อผู้ที่กำลังทำงานในโครงการหรือผลิตภัณฑ์ทั้งหมด
- นอกจากการให้เครดิตกับสมาชิกในทีมแล้ว ยังเป็นวิธีการบอกผู้คนว่าพวกเขาควรไปหาใครหากมีคำถามเกี่ยวกับข้อกำหนดทางเทคนิค
- หากคุณทำงานคนเดียวในโครงการ ให้ข้ามขั้นตอนนี้
ส่วนที่ 2 จาก 3: ร่างข้อกำหนดทางเทคนิค
ขั้นตอนที่ 1 เขียนสรุปสั้น ๆ ของโครงการหรือผลิตภัณฑ์
เริ่มเอกสารโดยสรุปสิ่งที่คุณกำลังทำ ป้อน "สรุป" เป็นชื่อส่วน อธิบายปัญหา ให้แนวคิดพื้นฐานของผลิตภัณฑ์หรือโครงการและหน้าที่ของมัน จากนั้นอธิบายว่าคุณตั้งใจจะบรรลุเป้าหมายสุดท้ายอย่างไรและแสดงรายละเอียดบางอย่าง กล่าวถึงเอกสารการตลาดหรือวิศวกรรมที่เกี่ยวข้อง และสุดท้าย ให้ประเมินเวลาที่จำเป็นในการดำเนินการผลิตภัณฑ์หรือโครงการให้เสร็จสมบูรณ์
เขียนบางอย่างเช่น: “ระบบการเดินทางในปัจจุบันทำให้เกิดความเข้มข้นของผู้โดยสารในสองบรรทัดและการใช้งานน้อยเกินไปของสายที่สาม เป็นไปได้ที่จะวางแผนการเดินทางบนอินเทอร์เน็ตสำหรับรถโดยสารสองสายเท่านั้น แต่อีกสายหนึ่งยังคงใช้งานได้กับแผนที่กระดาษและโทรศัพท์ โมเดลนี้ทำให้จำนวนผู้โดยสารลดลงและรายได้ของบริษัทลดลง ดังแสดงในรายงานเดือนกันยายน 2019 เราเสนอให้รวมระบบปัจจุบันเป็นระบบเดียวที่อนุญาตให้เข้าถึงอินเทอร์เน็ตไปยังรถโดยสารสามสายได้ ด้วยวิธีนี้ ผู้โดยสารจะมีวิธีที่ง่ายกว่าและเร็วกว่าในการเดินทางและจะทราบได้อย่างแน่ชัดว่ารถจะมาถึงจุดจอดเมื่อใด นอกจากนี้พวกเขาจะสามารถรายงานปัญหาโดยตรงกับฟังก์ชั่นการติดต่อ”
ขั้นตอนที่ 2 สร้างส่วนของวัตถุประสงค์หากไม่ครอบคลุมในสรุป
พิมพ์ "เป้าหมาย" เป็นชื่อและระบุสั้น ๆ ว่าคุณต้องการบรรลุอะไรกับโครงการหรือผลิตภัณฑ์ เริ่มต้นข้อความโดยแนะนำส่วนและกล่าวถึงวัตถุประสงค์ในรายการแบบแยกรายการหรือลำดับเลข
- หากคุณได้นำเสนอวัตถุประสงค์ในการสรุป ไม่จำเป็นต้องทำส่วนนี้ เว้นแต่บริษัทจะกำหนด
- เขียนบางอย่างเช่น: “ระบบใหม่ประกอบด้วย: 1) เครื่องมือการวางแผนเส้นทาง; 2) ฟังก์ชั่นตำแหน่งทางภูมิศาสตร์ของรถบัส 3) ช่องทางให้ผู้โดยสารสื่อสารปัญหา”
ขั้นตอนที่ 3 เขียนข้อกำหนดของผลิตภัณฑ์ในส่วนที่แยกต่างหาก
พิมพ์ "ข้อกำหนดของผลิตภัณฑ์" เป็นชื่อและอธิบายสิ่งที่จำเป็นในการแก้ไขปัญหา ใช้รายการหัวข้อและไม่ต้องกังวลกับการแนะนำส่วนนี้
ตัวอย่างเช่น: “1) ผู้วางแผนเส้นทางทำให้แน่ใจว่าผู้โดยสารจะไม่กระจุกตัวอยู่ในสายเพียงไม่กี่สาย 2) กล่องติดต่อเป็นวิธีที่อำนวยความสะดวกในการแก้ปัญหาข้อสงสัยของผู้โดยสาร”
ขั้นตอนที่ 4 อธิบายสิ่งที่อยู่นอกขอบเขตของโครงการ
ตั้งชื่อหัวข้อว่า "นอกขอบเขต" อย่าเขียนย่อหน้าเกริ่นนำ แต่ให้เขียนรายการสิ่งที่จะไม่ทำเพื่อแก้ปัญหา เช่น งานใดบ้างที่จะไม่เสร็จ วิธีแก้ปัญหาที่คุณพิจารณาว่าไม่เพียงพอ และคุณลักษณะที่ผลิตภัณฑ์หรือโครงการไม่มี มีความเฉพาะเจาะจงมากเพื่อให้ผู้บริโภคและพนักงานได้รับข้อความที่ถูกต้อง
เขียนประมาณนี้: “1) ระบบใหม่จะไม่เปลี่ยนเส้นทางของสายรถเมล์ 2) เราจะไม่วางคอมพิวเตอร์หรือหน้าจอไว้ที่ป้ายรถเมล์ ดังนั้นผู้โดยสารต้องใช้อุปกรณ์พกพาของตนเอง 3) เราไม่รับประกันการแก้ปัญหาในทันทีด้วยการเปลี่ยนแปลงระบบเท่านั้น 4) ผู้โดยสารจะไม่ถูกรับที่ประตูบ้าน”
ตัวเลือก:
เป็นเรื่องปกติที่ส่วนจะวางไว้ที่ส่วนท้ายของข้อกำหนดทางเทคนิคและก่อนไทม์ไลน์ เรียงลำดับตามที่ท่านต้องการหรือตามที่ท่านแจ้งไว้อย่างชัดเจน
ขั้นตอนที่ 5. รวมส่วน "คำถามเปิด" เพื่อหารือเกี่ยวกับปัญหาที่ยังไม่ได้แก้ไข
ข้อกำหนดทางเทคนิคนำเสนอภาพรวมของผลิตภัณฑ์หรือการออกแบบเพื่อให้ข้อมูลผู้บริโภคดีขึ้นและแนะนำทีมไปสู่เป้าหมายเดียวกัน อย่ากังวลกับการลงรายละเอียดทุกรายละเอียดหรือแก้ปัญหาทุกอย่าง แต่ให้สร้างส่วนที่เรียกว่า “ปัญหาที่เปิดอยู่” เพื่อแสดงรายการประเด็นที่จะแก้ไขในภายหลัง
เขียนเช่น: “1) เราจะจัดการกับระบบอัพเกรดอย่างไร? 2) เราจะเปลี่ยนเส้นทางหากเรามีปัญหาหรือไม่? 3) ระบบจะแสดงข้อมูลเป็นภาษาอื่นหรือไม่? 4) เราจะให้บริการผู้โดยสารที่ไม่เชี่ยวชาญเทคโนโลยีใหม่ได้อย่างไร”
ขั้นตอนที่ 6 นำเสนอแผนในส่วนแนวทาง
ตั้งชื่อว่า "แผน" หรือ "แนวทาง" แสดงว่าคุณตั้งใจจะแก้ปัญหาอย่างไรหรือแนวทางต่าง ๆ ที่กำลังพิจารณาอยู่หากโครงการยังอยู่ในช่วงเริ่มต้น อธิบายการวิจัยและประเภทของเทคโนโลยีและกระบวนการที่ใช้ หากเป็นไปได้ ให้แทรกรูปภาพ กราฟ และไดอะแกรมเพื่อให้ผู้อ่านเข้าใจได้ง่ายขึ้น สุดท้าย หารือเกี่ยวกับวิธีการดำเนินการทดสอบและสิ่งที่คุณจะดำเนินการหากมีปัญหา
- หากคุณต้องอธิบายวิธีการและเทคโนโลยีที่แตกต่างกัน ให้สร้างส่วนย่อยสำหรับแต่ละส่วน
- เขียนประมาณนี้: “เราจะทำงานร่วมกับทีมวางแผนการเดินทางเพื่อสร้างแอพที่อนุญาตให้ผู้โดยสารเข้าสู่ปลายทางที่ต้องการและสร้างเส้นทางโดยอัตโนมัติ ผู้ใช้สามารถเปลี่ยนเส้นทาง ระบบจะส่งข้อความอัปเดตเพื่อช่วยผู้โดยสารค้นหาเส้นทาง เราจะรวมลูกค้าบางส่วนในเซสชั่นการทดสอบที่จะจัดขึ้นก่อนการเปิดตัว เมื่อมีปัญหาเราจะทำการซ่อมบำรุงในตอนเช้าเมื่อรถเมล์ไม่ทำงาน นอกจากนี้เราจะมีรถเพิ่มเติมสำหรับรับผู้โดยสารที่ไม่สามารถขึ้นรถบัสได้เพราะเต็ม”
ตัวเลือก:
รวมส่วนที่ชื่อว่า "การเตรียมการ" เพื่อสรุปแผน มันมักจะเป็นทางเลือก
ขั้นตอนที่ 7 พูดคุยเกี่ยวกับตัวเลือกที่ได้รับการพิจารณา แต่ถูกละทิ้งในที่สุด
วางเนื้อหานี้เป็นขั้นตอนย่อยของแผนหรือที่ส่วนท้ายของเอกสารและก่อนเส้นเวลา เขียนใต้ชื่อ "ทางเลือกที่พิจารณา" และอธิบาย อธิบายว่าเหตุใดคุณจึงละทิ้งแต่ละตัวเลือก
เขียนแบบนี้: "เราถือว่าความเป็นไปได้ของการใช้แผนที่สีที่มีตำนานมีราคาถูกลง แต่ผู้โดยสารไม่ได้รับการยอมรับและกลุ่มทดสอบสับสน"
ขั้นตอนที่ 8 อธิบายผลิตภัณฑ์หรือวิธีการประเมินและการวัดผลโครงการ
วางเนื้อหาในส่วนเดียวหรือหลายส่วน ติดป้ายกำกับว่า "การวัดผลกระทบ" "การประเมิน" หรือ "การวัด" อธิบายในย่อหน้าหนึ่งหรือสองย่อหน้าว่าคุณจะแน่ใจได้อย่างไรว่าระบบทำงานอย่างถูกต้องและบรรลุเป้าหมาย อธิบายวิธีการตรวจสอบข้อผิดพลาดและปัญหาด้วย
- พูดคุยเกี่ยวกับกระบวนการวิเคราะห์และเทคโนโลยีที่จะใช้
- พูดบางอย่างเช่น: “เราจะทำการเปรียบเทียบระหว่างเวลาของเส้นทางโดยประมาณกับการเดินทางจริงเพื่อให้แน่ใจว่าคุณทำตามตารางเวลา นอกจากนี้ เราจะดำเนินการสำรวจร่วมกับผู้โดยสารเพื่อประเมินระดับความพึงพอใจและระบุปัญหา”
ขั้นตอนที่ 9 แสดงให้เห็นว่าคุณจะรักษาความปลอดภัยและความเป็นส่วนตัวได้อย่างไร
เขียนชื่อ “ความปลอดภัยและความเป็นส่วนตัว” และอธิบายว่าคุณจะปกป้องผู้ใช้จากการโจมตีทางดิจิทัลได้อย่างไร อธิบายความเสี่ยงและกลไกการปกป้องความเป็นส่วนตัวในสองสามย่อหน้า
- มีความเสี่ยงและปัญหาอยู่เสมอ ดังนั้นอย่าพูดว่าไม่มีอยู่จริง
- เขียนแบบนี้: “ผู้ใช้ระบุตำแหน่งปัจจุบันและที่อยู่บ้าน พวกเขาสามารถสร้างโปรไฟล์และบันทึกประวัติการเดินทางได้ เราจะใช้วิธีการเข้ารหัสและไฟร์วอลล์เพื่อปกป้องข้อมูล”
ขั้นตอนที่ 10. ปิดท้ายเอกสารด้วยไทม์ไลน์และรายการประทับเวลา
ไทม์ไลน์เป็นเครื่องมือสำคัญในการรักษาโครงการให้เป็นไปตามแผนและแสดงให้คุณเห็นอย่างชัดเจนว่าต้องทำอะไรและเมื่อใด ตั้งชื่อว่า "ไทม์ไลน์" และแบ่งงาน ทำรายการหัวข้อสำหรับแต่ละทีมหรือสมาชิก
- ตัวอย่างเช่น การแบ่งงานอาจรวมถึง "ทีมวิศวกร" "ทีมวางแผน" "การตลาด" และ "การประกันคุณภาพ"
- รายการสิ่งที่ต้องทำสำหรับทีมวิศวกรสามารถมีรายการต่างๆ เช่น: “1) พัฒนาการอัปเดตสำหรับไซต์ 2) เขียนแอพวางแผนการเดินทาง 3) โปรแกรมระบบการติดต่อ”
ส่วนที่ 3 จาก 3: การสิ้นสุดข้อกำหนดทางเทคนิค
ขั้นตอนที่ 1 ใช้ช่องว่างเดียวในเอกสารและข้ามบรรทัดระหว่างส่วนต่างๆ
พื้นที่เดียวลดขนาดของข้อกำหนดทางเทคนิคและทำให้เอกสารง่ายต่อการจัดการ เมื่อเปลี่ยนย่อหน้าหรือส่วน ให้ข้ามเพียงบรรทัดเดียวเพื่อไม่ให้มีช่องว่างที่ไม่จำเป็น
เป็นไปได้ว่าองค์กรจะให้คำแนะนำเฉพาะเกี่ยวกับการจัดรูปแบบ ถ้าเป็นเช่นนั้น ให้ปฏิบัติตามพวกเขา
ขั้นตอนที่ 2 ใช้สรรพนามพหูพจน์บุรุษที่สองในเอกสาร
ขณะที่คุณกำลังพูดถึงงานที่คุณและทีมของคุณจะทำ ให้ใช้ "เรา" เสมอ เมื่อกล่าวถึงทีมหรือบุคคลใดโดยเฉพาะ ให้ระบุชื่อเต็มเพื่อให้ข้อมูลอ้างอิงมีความชัดเจน ด้วยวิธีนี้คุณจะทำให้ข้อกำหนดทางเทคนิคมีวัตถุประสงค์มากขึ้น
- ตัวอย่างเช่น การเขียน "เราจะอัปเดตข้อกำหนดตามความจำเป็น" จะดีกว่า "ข้อกำหนดจะได้รับการอัปเดตตามความจำเป็น"
- ในทำนองเดียวกัน ให้พูดว่า "ทีมวิศวกรจะสร้างไซต์" หรือ "Marta de Sousa จะเป็นผู้รับผิดชอบในการกำหนดแผนการตลาด"
ขั้นตอนที่ 3 ใช้ภาษาที่ชัดเจน กระชับ และเข้าใจง่าย
อย่าขัดเกลาประโยคและแนวคิดในเอกสารประเภทนี้เพราะจะเสียเวลาและผู้อ่านเท่านั้น ใช้คำให้น้อยที่สุดเพื่อแสดงความคิดเห็นในรูปแบบการสอน ตรวจสอบรายงานและกำจัดคำที่ไม่จำเป็นและวลีที่ซ้ำซาก
ตัวอย่างเช่น เปลี่ยน “เราจะจัดทำเว็บไซต์ที่อนุญาตให้ผู้โดยสารวางแผนการเดินทางและตรวจสอบเส้นทางรถประจำทาง” เป็น “เว็บไซต์จะอนุญาตให้วางแผนการเดินทางและติดตามเส้นทางรถประจำทาง”
ขั้นตอนที่ 4 ขอให้เพื่อนร่วมงานตรวจทานเอกสารและให้คำแนะนำหรือวิพากษ์วิจารณ์
แบ่งปันข้อกำหนดทางเทคนิคกับสมาชิกในทีม ขอให้พวกเขาทำเครื่องหมายข้อผิดพลาดและแนะนำการปรับปรุง
ห้ามแสดงเอกสารให้บุคคลภายนอกดู เนื่องจากบุคคลนั้นอาจไม่เข้าใจสิ่งที่ง่ายสำหรับผู้เชี่ยวชาญและแนะนำการเปลี่ยนแปลงที่ไม่จำเป็น
ขั้นตอนที่ 5. ตรวจสอบเอกสารหากคุณต้องการแก้ไข
พิจารณาคำแนะนำและคำวิจารณ์เมื่ออ่านข้อกำหนดทางเทคนิคซ้ำ สิ่งที่สำคัญที่สุดคือลูกค้าและสมาชิกในทีมเข้าใจได้ง่าย อย่างไรก็ตาม อย่ากังวลกับการทำสิ่งที่สมบูรณ์แบบ
มีแนวโน้มว่าคุณจะต้องอัปเดตข้อกำหนดทางเทคนิคตลอดโครงการหรือการพัฒนาผลิตภัณฑ์ มันเป็นเอกสารชั่วคราว ดังนั้นอย่ายึดติดกับสิ่งที่มันพูด
ขั้นตอนที่ 6. ทบทวนให้ดีก่อนแจกจ่ายเอกสาร
อ่านอย่างน้อยสองครั้งและถ้าเป็นไปได้ ให้อ่านออกเสียง ให้ความสำคัญกับการพิมพ์ผิดและความหมายของคำ