การจัดการการเขียนรายละเอียด


9

ฉันไม่สามารถจินตนาการการเขียนซอฟต์แวร์โดยไม่มีสเป็ค ไม่ว่าร่างนั้นจะอยู่ในระดับสูงหรือสูง spec เป็นสิ่งสำคัญที่จะต้องอธิบายให้โปรแกรมเมอร์ที่ไม่รู้เรื่องเกี่ยวกับฟังก์ชันการทำงานของโปรแกรม

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

สถานการณ์อย่างน้อยหนึ่งเหตุการณ์จะเกิดขึ้น:

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

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

คุณจัดการข้อมูลจำเพาะของคุณอย่างไร ฉันพยายามให้ทุกคนใช้ Google เอกสาร แต่ทุกคนคัดค้าน ทุกคนแนบมาและหลงใหลใน Microsoft Word มากเกินไปซึ่งก็คือ - ในความเห็นของพวกเขา - ใช้งานง่ายมากง่ายมากที่จะแทรกภาพ, ง่ายมากที่จะพิมพ์สมการและอะไรก็ตาม

จะโน้มน้าวพวกเขาได้อย่างไรว่า MS Word นั้นยอดเยี่ยมสำหรับการแบ่งปัน?

คำตอบ:


6

จะโน้มน้าวพวกเขาได้อย่างไรว่า MS Word นั้นยอดเยี่ยมสำหรับการแบ่งปัน?

อย่าเสียเวลา

เป็นครั้งแรก ข้อมูลจำเพาะควรเป็นข้อความธรรมดา (จริงๆ) และอยู่ภายใต้การควบคุมของรหัสต้นฉบับ ใช้MarkdownหรือRSTหรือเครื่องมือมาร์กอัปน้ำหนักเบาอื่น ๆ เพื่อสร้างหน้า PDF หรือ HTML ข้อความธรรมดา.

ที่สอง ใช้แหล่งต่าง ๆ รวมพวกเขา เขียนเอกสารสุดท้ายของคุณเอง

เมื่อพวกเขาคัดค้านพวกเขามีสองทางเลือก

  1. ใช้ Google เอกสาร (หรือเครื่องมือควบคุมซอร์สโค้ด) เพื่อแก้ไขเวอร์ชันของคุณ

  2. ดำเนินการต่อเพื่อส่งการเปลี่ยนแปลงที่คุณแก้ไขตัวกรองและ morph ลงในเอกสารสุดท้าย

ฉันชอบ # 2 บางคนต้องการ "เป็นเจ้าของ" ข้อมูลจำเพาะ และกลุ่มคน (สไตล์ wiki) นำไปสู่การอภิปรายและสงครามการเปลี่ยนแปลงและเอกสารด้านข้างและการสนทนาแบบออฟไลน์และไม่ชอบ


1
+1 และจดจำRule of Least Power - ผู้ที่ต้องการรุ่นแฟนซีในโปรแกรมแก้ไขแบบ WYSIWYG สามารถคัดลอกมาร์กอัปที่แสดงผลได้
l0b0

@ l0b0: การเชื่อมโยงที่ดี
S.Lott

6

ฉันไม่คิดว่ามันเป็นปัญหา "เครื่องมือ" แต่เป็นปัญหา "กระบวนการ" (หรือขาดกระบวนการ)

คุณอาจมีกระบวนการที่จะปล่อยซอฟต์แวร์ (การทดสอบหน่วย, การรวมการทดสอบ, การเปิดตัวจดหมาย, การจัดส่งและอื่น ๆ ) คุณต้องดำเนินการตามกระบวนการเอกสารด้วย

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

2
+1: ปัญหาเครื่องมือมักจะเป็นอาการของปัญหากระบวนการ
S.Lott

เรามีกระบวนการ แต่ผู้คนเพียงแค่ชอบที่จะบ่นว่ากระบวนการไม่ทำงานและถูกตัดมุมถ้าเป็นไปได้
Graviton

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

4

จำเป็นต้องมีการควบคุมบางอย่าง

จะต้องมีรุ่นและลงชื่อออกและกระบวนการนี้จะต้องเข้มงวด

ในหลาย ๆ ที่การลงชื่อออกถูกละเลยและสิ่งนี้นำไปสู่การต่อสู้มวย

ตำแหน่งไม่สำคัญตราบใดที่สามารถติดตามได้

  • Sharepoint
  • ไดรฟ์ที่แชร์และปลอดภัย
  • ฉันเคยเห็นบางแห่งใช้การควบคุมซอร์สโค้ดของพวกเขา !!

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


+1, ฉันขอแนะนำอย่างยิ่งให้ย้ายเอกสาร spec ไปไว้ในแหล่งควบคุมหากไม่มีสิ่งใดช่วย ข้อดีอย่างหนึ่งคือคุณจะได้รับประวัติรุ่น แม้ว่าคุณจะไม่สามารถทำรุ่นที่แตกต่างได้ (เว้นแต่คุณจะพบปลั๊กอินที่สามารถแตกต่างกับไฟล์ Word) คุณยังสามารถแยกเวอร์ชันทั้งหมดและดูว่ามีอะไรเปลี่ยนแปลง สิ่งนี้มีประโยชน์มากในการโต้แย้งเรื่องข้อกำหนด การลงชื่อออกยังดีมาก และความสำคัญของการมีส่วนร่วมของทุกคนในกระบวนการ (ดังนั้นไม่มีใครสามารถพูดได้ว่า "เมื่อไรที่ตัดสินใจ?") ไม่สามารถเครียดได้เพียงพอ
FrustratedWithFormsDesigner

0

MS Word นั้นสมบูรณ์แบบสำหรับการสร้างสเป็ค เราจัดการของเราใน SharePoint ซึ่งจัดการเวอร์ชัน หากคุณไม่มี SharePoint หรือผลิตภัณฑ์การจัดการเอกสารที่มีประโยชน์ Google Docs ก็โอเค (ตอนนี้คุณสามารถอัปโหลดไฟล์. doc / .docx โดยไม่ต้องแปลงเป็นรูปแบบ Google เอกสาร) หรือตามที่คนอื่นแนะนำคุณสามารถเก็บไว้ในระบบควบคุมเวอร์ชันซอร์สโค้ดของคุณ (ถ้าคนที่สร้างรายละเอียดมีสิทธิ์เข้าถึงระบบนั้น)


0
 > How to convince them that MS Word is just terrible for sharing?

คุณไม่สามารถเปรียบเทียบความแตกต่างของสองอินสแตนซ์ในระบบควบคุมเวอร์ชันได้อย่างง่ายดาย

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

หมายเลขรุ่น (เกี่ยวข้องกับการตรวจสอบผลิตภัณฑ์) ผู้แต่งวันที่คำอธิบาย

โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.