วิธีการเขียนข้อกำหนดทางเทคนิค (พร้อมรูปภาพ)

สารบัญ:

วิธีการเขียนข้อกำหนดทางเทคนิค (พร้อมรูปภาพ)
วิธีการเขียนข้อกำหนดทางเทคนิค (พร้อมรูปภาพ)

วีดีโอ: วิธีการเขียนข้อกำหนดทางเทคนิค (พร้อมรูปภาพ)

วีดีโอ: วิธีการเขียนข้อกำหนดทางเทคนิค (พร้อมรูปภาพ)
วีดีโอ: ความแตกต่างของ Active Voice และ Passive Voice | Eng ลั่น [by We Mahidol] 2024, มีนาคม
Anonim

ข้อกำหนดทางเทคนิค (ข้อมูลจำเพาะทางเทคนิค) คือเอกสารที่อธิบายว่าผลิตภัณฑ์หรือโครงการจะทำอะไรและคุณจะบรรลุเป้าหมายเหล่านี้ได้อย่างไร ในข้อมูลจำเพาะทางเทคนิค แสดงให้ลูกค้าและสมาชิกในทีมเห็นว่าคุณกำลังแก้ปัญหาอะไร เป้าหมายหรือข้อกำหนดสำหรับโครงการหรือผลิตภัณฑ์ของคุณ และคุณวางแผนจะบรรลุเป้าหมายนี้อย่างไร ข้อมูลจำเพาะทางเทคนิคชี้นำงานให้สำเร็จ และโดยทั่วไปคุณจะเขียนใหม่เมื่อโครงการของคุณดำเนินไป

ขั้นตอน

ส่วนที่ 1 จาก 3: การเขียนส่วนหัว

เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 1
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 1

ขั้นตอนที่ 1 ใส่ชื่อโครงการที่ด้านบนโดยใช้แบบอักษรซานเซอริฟ 14-pt หรือ 16-pt

นี่คือชื่อผลิตภัณฑ์ของคุณหรือชื่อการทำงานของโครงการเอง ใช้ฟอนต์ sans serif 14-pt หรือ 16-pt เพื่อให้อ่านง่าย ชิดซ้ายหรือจัดชิดขอบ ขึ้นอยู่กับความชอบของคุณ

สถานที่ทำงานหรือผู้สอนของคุณอาจจัดเตรียมเทมเพลตที่แสดงวิธีการเขียนชื่อของคุณ ปฏิบัติตามเทมเพลตเสมอหากมี

เธอรู้รึเปล่า?

ฟอนต์ซานเซอริฟไม่มีขีดสิ้นสุดบนตัวอักษร ดังนั้นสไตล์เหล่านี้จึงดูทันสมัยกว่า ฟอนต์ซานเซอริฟที่ได้รับความนิยมมากที่สุด ได้แก่ Arial, Calibri และ Verdana

เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 2
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 2

ขั้นตอนที่ 2 เขียนวันที่ด้านล่างชื่อโครงการด้วยฟอนต์ sans serif ขนาด 12 พอยต์

ไปที่บรรทัดถัดไปและลดขนาดฟอนต์ของคุณเป็น 12-pt ใช้ฟอนต์ sans serif เดียวกันกับที่คุณใช้เขียนชื่อโปรเจ็กต์ของคุณ จากนั้นพิมพ์วันที่โดยใช้เดือน วัน และปี

  • หากเทมเพลตของคุณแตกต่างกัน ให้จัดรูปแบบวันที่ตามเทมเพลต
  • สิ่งสำคัญคือต้องใส่วันที่เพื่อให้คุณสามารถบอกได้ว่าข้อมูลจำเพาะทางเทคนิคใดเป็นข้อมูลล่าสุด
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 3
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 3

ขั้นที่ 3. พิมพ์ “ผู้แต่ง” และชื่อผู้แต่งใต้วันที่

ไปที่บรรทัดถัดไปและเขียน "Author" ตามด้วยโคลอน จากนั้นใส่ชื่อของคุณเนื่องจากคุณเป็นคนเขียนข้อมูลจำเพาะทางเทคนิค ใส่เพียงชื่อของคุณเสมอ แม้ว่าคุณจะพูดถึงเนื้อหาของข้อมูลจำเพาะทางเทคนิคกับทีมก็ตาม

ข้อมูลจำเพาะทางเทคนิคจำเป็นต้องมีผู้เขียนคนเดียวเสมอ แม้ว่าคุณจะทำงานร่วมกับทีมก็ตาม ผู้เขียนคือคนที่พิมพ์ข้อมูลจำเพาะจริงๆ

เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 4
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 4

ขั้นตอนที่ 4. วาง “ทีม” และชื่อสมาชิกในทีมจะอยู่ท้ายสุด

ในบรรทัดถัดไป ให้พิมพ์ "Team" ตามด้วยเครื่องหมายทวิภาค จากนั้นเขียนชื่อสมาชิกในทีมแต่ละคนที่ทำงานในโครงการหรือผลิตภัณฑ์

  • นอกจากการให้เครดิตกับสมาชิกในทีมแล้ว วิธีนี้ยังช่วยให้ผู้คนเข้าใจว่าพวกเขาสามารถไปหาใครได้บ้างหากมีคำถามเกี่ยวกับข้อมูลจำเพาะทางเทคนิค
  • หากคุณทำงานคนเดียวในโครงการนี้ ให้ข้ามขั้นตอนนี้

ส่วนที่ 2 จาก 3: การร่างข้อกำหนดทางเทคนิค

เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 5
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 5

ขั้นตอนที่ 1 ให้ภาพรวมหรือสรุปโดยย่อของโครงการหรือผลิตภัณฑ์

เริ่มข้อมูลจำเพาะทางเทคนิคของคุณด้วยสรุปสิ่งที่คุณทำ พิมพ์ "ภาพรวม" หรือ "สรุปโดยย่อ" เป็นส่วนหัวของคุณ อธิบายปัญหา แล้วสรุปว่าโครงการหรือผลิตภัณฑ์คืออะไร และจะทำอะไร ถัดไป อธิบายว่าแนวทางของคุณในการทำให้สำเร็จคืออะไร และระบุข้อมูลจำเพาะของผลิตภัณฑ์หากเป็นอุปกรณ์ เชื่อมโยงไปยังเอกสารการตลาดหรือวิศวกรรมที่มีความสำคัญต่อโครงการ สุดท้าย ให้ระบุเวลาคร่าวๆ คร่าวๆ ว่าจะใช้เวลานานแค่ไหนกว่าจะเสร็จสิ้นโครงการหรือผลิตภัณฑ์

คุณอาจเขียนว่า “ระบบปัจจุบันสำหรับการวางแผนการเดินทางขนส่งข้ามเขตทำให้ผู้ขับขี่ติดค้างและลดจำนวนผู้โดยสารในบางเส้นทาง ระบบรถโดยสารสองระบบอนุญาตให้ผู้โดยสารวางแผนการเดินทางออนไลน์ได้ แต่ระบบที่สามใช้แผนที่กระดาษและการติดต่อทางโทรศัพท์ โซลูชันนี้ทำให้จำนวนผู้โดยสารลดลงและทำให้เกิดภายใต้เงินทุน ดูผลการสำรวจฤดูใบไม้ผลิปี 2019 เราต้องการย้ายทั้ง 3 เส้นทางเข้าสู่ 1 ระบบการวางแผนที่ผู้ใช้สามารถเข้าถึงออนไลน์ได้ ซึ่งจะช่วยให้วางแผนการเดินทางได้ง่ายขึ้นและดูว่ารถเมล์จะจอดแต่ละป้ายเมื่อใด นอกจากนี้ ผู้ขับขี่สามารถรายงานปัญหาได้ทันทีโดยใช้ฟังก์ชัน 'ติดต่อเรา'”

เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 6
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 6

ขั้นตอนที่ 2 รวมส่วนเป้าหมายหากไม่ได้อยู่ในภาพรวมหรือสรุปโดยย่อ

พิมพ์ "เป้าหมาย" เป็นส่วนหัว จากนั้นสรุปคร่าวๆ ว่าคุณวางแผนจะทำอะไรให้สำเร็จด้วยโครงการหรือผลิตภัณฑ์ของคุณ เขียนข้อความแจ้งล่วงหน้า จากนั้นระบุเป้าหมายของคุณในรายการที่มีตัวเลขหรือสัญลักษณ์แสดงหัวข้อย่อย

  • หากคุณร่างเป้าหมายในส่วนภาพรวม โดยทั่วไปคุณไม่จำเป็นต้องใช้ส่วนนี้ อย่างไรก็ตาม คุณอาจจำเป็นต้องรวมส่วนนี้ไว้หากสถานที่ทำงานของคุณต้องการ
  • เขียนประมาณว่า “ระบบใหม่จะประกอบด้วย 1) เครื่องมือในการวางแผนเส้นทาง 2) ฟังก์ชั่นระบุตำแหน่งรถบัส; 3) ช่องทางให้นักปั่นรายงานปัญหา”
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่7
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่7

ขั้นตอนที่ 3 เขียนข้อกำหนดของผลิตภัณฑ์ในส่วนแยกต่างหาก

ถัดไป พิมพ์ "ข้อกำหนดของผลิตภัณฑ์" เป็นส่วนหัว ตามด้วยสิ่งที่ผลิตภัณฑ์ของคุณต้องทำเพื่อแก้ปัญหาของคุณ ใช้รายการหัวข้อย่อยและไม่ต้องกังวลกับประโยคนำหน้า

ตัวอย่างเช่น “1) ผู้วางแผนเส้นทางช่วยให้ผู้ขับขี่ไม่ติดค้างและรถประจำทางไม่ได้ใช้งานน้อยเกินไป 2) กล่องติดต่อช่วยให้ผู้วางแผนการขนส่งสามารถตอบสนองต่อปัญหาของผู้ขับขี่ได้โดยตรง”

เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 8
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 8

ขั้นตอนที่ 4 อธิบายสิ่งที่อยู่นอกขอบเขตของโครงการของคุณ

ตั้งชื่อหัวข้อนี้ว่า "อยู่นอกขอบเขต" หรือ "ไม่ใช่เป้าหมาย" อย่าเขียนคำนำหน้าหรือย่อหน้า แทนที่จะสร้างรายการหัวข้อย่อยของสิ่งที่คุณจะไม่ทำเพื่อแก้ปัญหาของคุณ ซึ่งรวมถึงงานที่คุณจะไม่ทำ โซลูชันที่คุณไม่คิดว่าจะใช้ได้ และคุณลักษณะของผลิตภัณฑ์หรือโครงการของคุณจะไม่มี ละเอียดถี่ถ้วนเพื่อให้ลูกค้าและทีมของคุณไม่มีความเข้าใจผิดใดๆ

คุณอาจเขียนว่า “1) ระบบนี้จะไม่เพิ่มเส้นทางรถเมล์ใหม่ 2) เราจะไม่ติดตั้งคอมพิวเตอร์ที่ป้ายรถเมล์หรือบนรถโดยสาร ดังนั้นผู้ขับขี่จะต้องใช้อุปกรณ์ของตนเอง 3) ผู้วางแผนระบบขนส่งจะไม่รับประกันวิธีแก้ปัญหาในทันทีสำหรับปัญหาของผู้โดยสาร และ 4) บริการนี้จะไม่รวมรถกระบะแบบ door-to-door”

ตัวเลือกสินค้า:

บางครั้งส่วนนี้จะถูกวางไว้ใกล้กับจุดสิ้นสุดของข้อมูลจำเพาะทางเทคนิคก่อนเส้นเวลา ใช้ตำแหน่งที่คุณต้องการหรือทำสิ่งที่พบบ่อยที่สุดในที่ทำงานของคุณ

เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 9
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 9

ขั้นตอนที่ 5 รวมส่วน "คำถามเปิด" หากคุณมีปัญหาที่ยังไม่ได้รับการแก้ไข

ข้อมูลจำเพาะทางเทคนิคของคุณเป็นโครงร่างสั้นๆ ของผลิตภัณฑ์หรือโครงการ เพื่อให้ลูกค้าของคุณเข้าใจว่าพวกเขากำลังได้รับอะไร และทีมของคุณกำลังทำงานในเป้าหมายเดียวกัน ไม่ต้องกังวลกับการใส่ทุกรายละเอียดหรือตอบคำถาม "เพื่อความมุ่งมั่น" ของคุณ ให้พิมพ์หัวข้อ "คำถามเปิด" และแสดงรายการหัวข้อย่อยของสิ่งที่คุณจะตัดสินใจในภายหลัง

เขียนว่า “1) เราจะจัดการการอัปเดตระบบอย่างไร? 2) เราจะเปลี่ยนแผนที่เส้นทางหากพบปัญหาหรือไม่? 3) ระบบสามารถให้บริการผู้โดยสารได้หลายภาษาโดยไม่มีข้อผิดพลาดในการแปลหรือไม่? 4) เราจะให้บริการผู้ขับขี่ที่ไม่เข้าใจเทคโนโลยีได้ดีที่สุดอย่างไร”

เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 10
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 10

ขั้นตอนที่ 6 นำเสนอแผนของคุณในส่วน "แนวทาง"

ตั้งชื่อหัวข้อนี้ว่า "แผน" หรือ "แนวทาง" อธิบายว่าคุณจะแก้ปัญหาอย่างไรหรือแนวทางต่างๆ ที่คุณกำลังพิจารณาหากยังไม่มีการตัดสินใจขั้นสุดท้าย อธิบายงานวิจัยของคุณและเทคโนโลยีหรือกระบวนการแต่ละอย่างที่คุณจะใช้ ถ้าเป็นไปได้ ให้ใส่ภาพประกอบ แผนภูมิ และไดอะแกรมเพื่อให้ผู้อ่านเข้าใจแผนของคุณได้ง่ายขึ้น สุดท้าย สนทนาว่าคุณจะทดสอบแผนของคุณอย่างไรและคุณจะทำอย่างไรหากมีปัญหา

  • หากคุณอธิบายวิธีการหรือเทคโนโลยีที่แตกต่างกัน ให้สร้างส่วนย่อยสำหรับแต่ละส่วนเพื่อให้แผนของคุณง่ายต่อการปฏิบัติตาม
  • เขียนประมาณว่า “เราจะทำงานร่วมกับทีมวางแผนการขนส่งเพื่อออกแบบซอฟต์แวร์ที่ช่วยให้ผู้ขับขี่ป้อนจุดหมายปลายทางลงในแอพที่จะสร้างเส้นทางสำหรับพวกเขา ผู้ขับขี่สามารถเปลี่ยนเส้นทางได้หากต้องการ ระบบจะส่งข้อความอัปเดตไปยังผู้ขับขี่เพื่อช่วยในการค้นหาเส้นทาง เราจะให้ผู้ขับขี่ในคณะกรรมการผู้มีส่วนได้ส่วนเสียทดสอบซอฟต์แวร์ก่อนที่เราจะเผยแพร่สู่สาธารณะ หากแผนมีข้อผิดพลาด เราจะทำการอัปเดตไซต์ในช่วงเวลาที่รถประจำทางออฟไลน์ นอกจากนี้ เราจะมีรถรับส่งเพิ่มเติมสำหรับรับผู้โดยสารที่ติดค้างเพราะระบบ”

ตัวเลือกสินค้า:

คุณอาจรวมส่วน "ส่วนประกอบ" ที่ด้านบนเพื่อสรุปว่าแผนหรือแนวทางของคุณจะนำมาซึ่งอะไร อย่างไรก็ตาม วิธีนี้มักจะเป็นทางเลือก เว้นแต่บริษัทหรือผู้สอนของคุณต้องการ

เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 11
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 11

ขั้นตอนที่ 7 รวมตัวเลือกอื่น ๆ ที่คุณพิจารณาแต่ตัดออก

ใส่ส่วนนี้เป็นขั้นตอนย่อยในแผนหรือแนวทางของคุณ หรือวางไว้ที่ส่วนท้ายของข้อมูลจำเพาะก่อนไทม์ไลน์ของคุณ พิมพ์ส่วนหัว "ตัวเลือกอื่น ๆ ที่พิจารณา" จากนั้นอธิบายทางเลือกอื่นที่คุณพิจารณาก่อนที่คุณจะเลือกแผนปัจจุบันของคุณ อธิบายว่าเหตุใดคุณจึงตัดตัวเลือกแต่ละข้อออก

คุณอาจเขียนว่า "เราพิจารณาแผนที่ที่มีรหัสสีเพราะเป็นตัวเลือกที่ถูกกว่า แต่ผู้ขับขี่ไม่ตอบสนองต่อแผนที่ที่มีอยู่และกลุ่มทดสอบก็สับสน"

เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 12
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 12

ขั้นตอนที่ 8 อธิบายวิธีการและตัวชี้วัดของคุณสำหรับการประเมินผลิตภัณฑ์หรือโครงการ

รวมข้อมูลนี้ในส่วนเดียวหรือหลายส่วน ตั้งชื่อว่า "การวัดผลกระทบ" หรือ "การตรวจสอบ" และ "เมตริก" ในหนึ่งย่อหน้าขึ้นไป ให้อธิบายว่าคุณจะแน่ใจได้อย่างไรว่าผลิตภัณฑ์หรือโครงการของคุณทำงานอย่างถูกต้องและบรรลุเป้าหมายของคุณ นอกจากนี้ ให้อธิบายว่าคุณจะตรวจสอบจุดบกพร่องหรือปัญหาอย่างไร

  • รวมกระบวนการวิเคราะห์เฉพาะหรือเทคโนโลยีที่คุณจะใช้
  • พูดบางอย่างเช่น “เราจะเปรียบเทียบเวลาของเส้นทางที่คาดการณ์ไว้กับเวลาจริงในเส้นทางเพื่อให้แน่ใจว่ารถเมล์ตรงเวลา นอกจากนี้ เราจะดำเนินการสำรวจผู้ขับขี่เพื่อประเมินความพึงพอใจและระบุปัญหาของระบบ”
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 13
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 13

ขั้นตอนที่ 9 ระบุว่าคุณจะให้การรักษาความปลอดภัยและความเป็นส่วนตัวอย่างไร

พิมพ์ส่วนหัว "ความปลอดภัยและความเป็นส่วนตัว" จากนั้นอธิบายว่าคุณจะปกป้องผู้ใช้จากการโจมตีทางไซเบอร์ได้อย่างไร อธิบายสั้น ๆ เกี่ยวกับความเสี่ยงและวิธีที่คุณจะรักษาความปลอดภัยให้กับระบบของคุณ เพื่อปกป้องความเป็นส่วนตัว เขียนสองสามย่อหน้าเพื่ออธิบายวิธีการของคุณ

  • มีความเสี่ยงหรือข้อกังวลอยู่เสมอ ดังนั้นอย่าใส่ "ไม่มีความเสี่ยง" ในส่วนนี้
  • คุณอาจเขียนว่า “ผู้ใช้จะป้อนตำแหน่งและที่อยู่บ้านของพวกเขา นอกจากนี้ พวกเขาจะมีตัวเลือกในการสร้างโปรไฟล์และบันทึกการเดินทาง เพื่อปกป้องข้อมูลนี้ เราจะรวมการเข้ารหัสและไฟร์วอลล์ไว้ด้วย”
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 14
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 14

ขั้นตอนที่ 10. จบด้วยไทม์ไลน์และรายการเหตุการณ์สำคัญ

ไทม์ไลน์ช่วยให้โครงการของคุณเป็นไปตามแผนและบอกทั้งลูกค้าและทีมของคุณว่าต้องทำอะไร ตั้งชื่อหัวข้อนี้ว่า “ไทม์ไลน์” แล้วแยกย่อยงานตามว่าใครเป็นคนทำ รวมรายการหัวข้อย่อยสำหรับแต่ละทีมหรือสมาชิกในทีม ขึ้นอยู่กับความชอบของคุณ

  • ตัวอย่างเช่น การแบ่งงานของคุณอาจแสดงรายการ “ทีมวิศวกร” “ทีมวางแผน” “การตลาด” และ “การประกันคุณภาพ”
  • รายการหัวข้อย่อยของคุณสำหรับทีมวิศวกรอาจรวมถึงงานต่างๆ เช่น “1) เขียนการอัปเกรดเว็บไซต์ 2) เขียนแอพวางแผนการเดินทาง; 3) เขียนระบบการติดต่อ”

ส่วนที่ 3 จาก 3: การสรุปข้อมูลจำเพาะทางเทคนิคของคุณ

เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 15
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 15

ขั้นตอนที่ 1 เว้นวรรคในเอกสารของคุณและข้าม 1 บรรทัดระหว่างส่วนต่างๆ

ใช้ระยะห่างเดียวเพื่อให้ข้อมูลจำเพาะทางเทคนิคของคุณสั้นลงและจัดการได้ง่ายขึ้น เมื่อต้องการเปลี่ยนย่อหน้าหรือส่วน ให้ข้าม 1 บรรทัด ซึ่งจะช่วยให้ผู้อ่านติดตามได้โดยไม่ต้องเพิ่มหน้าที่ไม่จำเป็น

ที่ทำงานหรือผู้สอนของคุณอาจให้คำแนะนำการจัดรูปแบบที่แตกต่างกัน ถ้าเป็นเช่นนั้น ให้ปฏิบัติตามคำแนะนำเหล่านี้

เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 16
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 16

ขั้นตอนที่ 2 ใช้มุมมองบุคคลที่หนึ่งตลอดข้อมูลจำเพาะทางเทคนิคของคุณ

เนื่องจากคุณกำลังพูดถึงงานที่คุณและทีมของคุณจะทำสำเร็จ ให้ใช้สรรพนามบุรุษที่หนึ่ง "ฉัน" "ฉัน" "เรา" และ "เรา" เสมอ เมื่อคุณพูดถึงทีมหรือบุคคลใดทีมหนึ่ง ให้ใช้ชื่อของพวกเขาเพื่อให้ชัดเจนว่าคุณกำลังพูดถึงใคร สิ่งนี้ทำให้ข้อมูลจำเพาะทางเทคนิคตรงและตรงประเด็นเพราะผู้อ่านรู้ว่าแต่ละการกระทำจะเสร็จสิ้นอย่างไร

  • ตัวอย่างเช่น พูดว่า "เราจะอัปเดตข้อกำหนดตามความจำเป็น" แทนที่จะเป็น "ข้อกำหนดจะได้รับการอัปเดตตามความจำเป็น"
  • ในทำนองเดียวกัน เขียนว่า "ทีมวิศวกรจะเขียนเว็บไซต์" หรือ "เอมี่จะร่างแผนการตลาด"
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 17
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 17

ขั้นตอนที่ 3 เขียนข้อความที่ชัดเจนและรัดกุมซึ่งง่ายต่อการปฏิบัติตาม

อย่าอธิบายความคิดของคุณในข้อมูลจำเพาะทางเทคนิคเพราะมันเสียเวลาและผู้อ่านของคุณ ใช้คำให้น้อยที่สุดเพื่อแสดงความคิดเห็นและจัดระเบียบความคิดเพื่อให้ง่ายต่อการติดตาม อ่านรายงานของคุณและกำจัดการใช้ถ้อยคำที่ไม่จำเป็นและประโยคที่ซ้ำซาก เพื่อให้รายงานของคุณตรงยิ่งขึ้น

ตัวอย่างเช่น คุณสามารถแก้ไข "เราจะเขียนเว็บไซต์ที่ช่วยให้ผู้ขับขี่สามารถวางแผนการเดินทางที่ต้องการและติดตามรถบัสได้" เป็น "เว็บไซต์นี้อนุญาตให้วางแผนการเดินทางและติดตามรถประจำทางได้"

เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 18
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 18

ขั้นตอนที่ 4 หาพันธมิตรเพื่อตรวจสอบข้อมูลจำเพาะทางเทคนิคของคุณและให้ข้อเสนอแนะ

แชร์ข้อมูลจำเพาะทางเทคนิคของคุณกับสมาชิกในทีมหรือเพื่อนร่วมชั้นที่จะเข้าใจ ขอให้พวกเขาทำเครื่องหมายข้อผิดพลาดที่พวกเขาเห็นและให้ข้อเสนอแนะเกี่ยวกับจุดที่คุณสามารถปรับปรุงได้

อย่าแสดงข้อมูลจำเพาะทางเทคนิคของคุณกับผู้ที่ไม่เข้าใจสาขาของคุณ พวกเขาอาจจะสับสนและอาจแนะนำการเปลี่ยนแปลงที่ไม่จำเป็น

เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 19
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 19

ขั้นตอนที่ 5. แก้ไขข้อมูลจำเพาะทางเทคนิคของคุณ หากจำเป็นต้องเปลี่ยนแปลง

ตามความคิดเห็นที่คุณได้รับ ให้ย้อนกลับไปดูข้อมูลจำเพาะทางเทคนิคของคุณ และทำการแก้ไขหากรู้สึกว่าจำเป็น มุ่งเน้นที่การทำให้ข้อมูลจำเพาะทางเทคนิคที่ลูกค้าและทีมงานของคุณเข้าใจได้ อย่างไรก็ตามอย่ากังวลว่าจะไม่สมบูรณ์แบบ

คุณอาจต้องอัปเดตข้อมูลจำเพาะทางเทคนิคเมื่อโครงการหรือผลิตภัณฑ์ของคุณดำเนินไป นี่เป็นเอกสารชั่วคราว ดังนั้นอย่าปล่อยให้คุณไม่สามารถทำงานจริงได้

เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 20
เขียนข้อกำหนดทางเทคนิค ขั้นตอนที่ 20

ขั้นตอนที่ 6 พิสูจน์อักษรข้อมูลจำเพาะทางเทคนิคของคุณก่อนที่จะแจกจ่าย

อ่านข้อมูลจำเพาะทางเทคนิคของคุณอย่างน้อยสองครั้งเพื่อตรวจสอบข้อผิดพลาด หากทำได้ ให้อ่านออกเสียงเพื่อช่วยในการจับข้อผิดพลาด เน้นไปที่สิ่งต่างๆ เช่น การสะกดผิดหรือคำที่อาจเปลี่ยนความหมายของเอกสารของคุณ

ตัวอย่างเช่น ค้นหาข้อผิดพลาดเช่น "ระบบปัจจุบันมีประสิทธิภาพ" มากกว่า "ระบบปัจจุบันไม่มีประสิทธิภาพ"

แนะนำ: