ฉันพบเอกสารใด ๆ นั้นดีกว่าไม่มีเอกสาร จำนวนที่เหมาะสมมักจะถูกกำหนดโดยจำนวนเวลาที่เราต้องทำหรือโดยจำนวนที่เราเกลียดการสนับสนุนโทรศัพท์และอีเมล
ดูเหมือนว่าสมาชิกในทีมปัจจุบันของคุณมีความคาดหวังที่ไม่สมจริงบางอย่างเกี่ยวกับความทรงจำของพวกเขาหรือพวกเขารู้สึกละอายใจกับทักษะการเขียนของพวกเขาและไม่เต็มใจที่จะฝึกฝน
ฉันรู้ว่าฉันเป็นชนกลุ่มน้อย (ผู้สอนภาษาอังกฤษที่เข้าสู่วิศวกรรมซอฟต์แวร์ในระดับบัณฑิตศึกษา) ที่นี่เนื่องจากฉันไม่พบเอกสารที่น่าเบื่อ มันเป็นเครื่องมือระดับมืออาชีพที่มีค่า ฉันไม่อาจเขียนยากที่จะทำเหมือนเพื่อนร่วมงานบางคน แต่นั่นเป็นเพราะฉันมีการฝึกฝนมากกว่านี้ ฉันไม่คิดว่าโครงการจะแล้วเสร็จเว้นแต่จะมีเอกสารประกอบและฉันมักจะเขียนด้วยเหตุผลที่เห็นแก่ตัวอย่างหมดจด: ดังนั้นฉันสามารถให้คนอ่านแทนการโทรศัพท์และอีเมลหรือเพื่อให้ฉันสามารถจำสิ่งที่เรากำลังพูดถึงล่าสุด เดือนหรือดังนั้นฉันสามารถอ้างถึงวิธีที่ฉันทำบางสิ่งบางอย่างถ้าฉันต้องการที่จะสนับสนุนในตอนกลางคืน
วิธีที่ดีที่สุดในการเข้าถึงเอกสารประกอบคือการเขียน AS You GO เหมือนกับการเขียนรหัสทดสอบ เป็นเรื่องที่น่าประหลาดใจที่มีเทมเพลตที่เขียนไว้ล่วงหน้าสองสามชุด (ที่มีส่วนหัว, โค้ดที่ไม่สมบูรณ์ ฯลฯ ) สามารถทำให้เอกสารง่ายขึ้นและเร็วขึ้น วิธีนี้คุณสามารถจับภาพการเปลี่ยนแปลงเมื่อมันเกิดขึ้นและคุณมีพื้นที่น้อยกว่าที่จะครอบคลุมช่วงเวลา คุณมีประสิทธิภาพมากขึ้นด้วยวิธีนี้เนื่องจากคุณสามารถอ้างถึงเอกสารตามที่คุณต้องการและคุณเปลี่ยนแปลงไปตลอดทาง ตัวอย่างเช่นการทำในวิกิทำให้การปรับปรุงง่ายขึ้นและคุณสามารถหลีกเลี่ยงปัญหาเกี่ยวกับเวอร์ชันของเอกสารหากล่าสุดและยิ่งใหญ่ที่สุดออนไลน์อยู่เสมอในที่เดียวกันและคุณสามารถส่งลิงก์ไปยังผู้ที่ต้องการอ่าน
หากคุณใช้เวลาเล็กน้อยในการบันทึกคุณจะทำงานได้เร็วขึ้นโดยเฉพาะเมื่อมีคนใหม่เข้ามาร่วมทีมเนื่องจากพวกเขาจะไม่ต้องใช้เวลาทั้งหมดในการหาทุกสิ่ง การค้นหาสิ่งต่าง ๆ เป็นส่วนที่สนุกของงานของเรา แต่มันไม่สนุกเมื่อคุณต้องรีบแก้ไขการผลิต เราทุกคนประหยัดเวลาได้มากหากเราเขียนบันทึกเพิ่มเติมอีกสองสามรายการ
ทีมของคุณมีปัญหาเดียวกันกับการทดสอบหรือการเขียนรหัสทดสอบหรือไม่? ถ้าไม่เช่นนี้จะเป็นการขายที่ง่ายขึ้น
เอกสารของคุณมีประโยชน์ในหลาย ๆ ด้าน:
1) สำหรับคุณในตอนนี้และกับเพื่อนร่วมงานของคุณเมื่อคุณทำงานในโครงการ
2) ให้กับลูกค้าของคุณ การมีเอกสารประกอบ (รวมถึงไดอะแกรม) ที่คุณสามารถแสดงให้ผู้ใช้ทำให้การสนทนาในการประชุมง่ายขึ้นโดยเฉพาะถ้าคุณกำลังพูดถึงระบบที่ซับซ้อน แม้ว่าเอกสารจะไม่สมบูรณ์ แต่เป็นจุดเริ่มต้น
3) สำหรับคนที่จะสืบทอดงานของคุณ (ซึ่งอาจเป็นคุณในสามปี) เพื่อนร่วมงานวัยเยาว์ของฉันหลายคนคิดว่าพวกเขาจะจดจำสิ่งของได้ตลอด ฉันรู้ว่าฉันจำไม่ได้เมื่อสัปดาห์ที่แล้วถ้าฉันไม่จดไว้ การมีเอกสารช่วยให้คุณไม่ต้องใช้เวลาครึ่งวันในการจดจำว่าคุณมีโครงสร้างอย่างไรและต้องคิดออกใหม่อีกครั้ง
4) สำหรับคุณและคนอื่น ๆ หากสถานการณ์ได้รับการเมืองหรือความขัดแย้ง ในฐานะที่เป็นคนที่จดบันทึกในการประชุมเพื่อให้ตัวเองตื่นตัวและต่อสู้กับความเบื่อหน่ายฉันมักจะเป็นคนเดียวที่มีเวอร์ชันการตัดสินใจเป็นลายลักษณ์อักษร คนที่เขียนมันลงไปชนะการโต้เถียง จำไว้ว่าในครั้งต่อไปที่มีคนพูดว่า "โปรดจำไว้ว่าการประชุมที่เรามีฤดูหนาวที่ผ่านมานี้ในห้องประชุม 4 เมื่อเราไปมากกว่า X? Fred อยู่ที่นั่นและใครเป็นคนที่มาจากการบัญชี?"