ฉันจะบันทึกงานที่ผ่านมาของคนอื่นได้อย่างไร [ปิด]

เราอยู่ในสถานการณ์ที่ไม่ดีที่มีเอกสารน้อยมากเกี่ยวกับการปรับแต่งคนงานที่ผ่านมาของเราทำกับระบบที่สำคัญทางธุรกิจ มีการเปลี่ยนแปลงมากมายใน Crystal Reports เอนทิตีฐานข้อมูลและไฟล์การตั้งค่า / การเขียนโปรแกรมกรรมสิทธิ์สำหรับซอฟต์แวร์ ERP ของเรา

เอกสารปัจจุบันโดยทั่วไปจะอ่านบางสิ่งเช่นนี้

โปรแกรมนี้ทำงานก่อนออกใบแจ้งหนี้ ข้อบกพร่องที่รู้จัก: ไม่มี

เรียกใช้โปรแกรมนี้หลังจากติดตั้งซอฟต์แวร์ X

เปลี่ยนฟิลด์ต่อไปนี้ในรายงานนี้: (โดยไม่มีคำอธิบายว่าอย่างไรหรือทำไม)

ร้านไอทีของเรามีขนาดเล็กและในกรณีของซอฟต์แวร์ ERP งานส่วนใหญ่ถูกทิ้งให้กับคนคนเดียว แผนกไอทีและการบัญชีรู้บิตและชิ้นส่วน (บางครั้งก็ค่อนข้างมีประโยชน์) แต่ก็ยังไม่เพียงพอ

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

ฉันจะบันทึกเกี่ยวกับการเปลี่ยนแปลงในอดีตได้อย่างไรเมื่อฉันไม่รู้ว่าทำอะไรทั้งหมด ฉันสามารถเริ่มต้นด้วยการบันทึกสิ่งที่เราเปลี่ยนแปลง: ไฟล์, ตารางฐานข้อมูลและสิ่งที่เราต้องมีเพื่อให้ระบบทำงานได้ ฉันยังสามารถเอกสารสิ่งที่เราทำ ; เมื่อมีการเรียกใช้รายงานเหตุใดจึงมีคนบอกให้ใช้รายงาน / โปรแกรม X แต่เมื่อหนึ่งในสิ่งที่กำหนดเองเหล่านี้มีปัญหาฉันมักจะกลับไปที่จตุรัสหนึ่ง

ฉันจะบันทึกสิ่งนี้ให้ฉันและคนอื่นได้อย่างไร

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

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

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

ละทิ้งความพยายามของคุณไปยังเอกสารการเปลี่ยนแปลง

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

คุณมีการควบคุมแหล่งที่มา?

คุณช่วยหาสิ่งที่เปลี่ยนแปลงไปจากสิ่งนั้นได้หรือไม่?

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

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

สิ่งแรกสิ่งแรก คุณเก็บเอกสารของคุณอยู่ที่ไหน หากคุณยังไม่ได้ติดตั้ง wiki ฉันชอบdokuwiki ด้วยตัวเองและยังมีvm ที่สร้างไว้ล่วงหน้าหากคุณมีความโน้มเอียง

นี่เป็นคุณสมบัติที่สำคัญบางประการ:

• เอกสารสามารถเข้าถึงได้ทุกที่บน บริษัท lan (ติดตั้งบนคอมพิวเตอร์เครื่องใหม่ ... )
• เอกสารทั้งหมดอยู่ในที่เดียว
• เอกสารทั้งหมดสามารถค้นหาได้
• คุณสามารถทำงานร่วมกัน (เพื่อนร่วมงานใหม่ผู้ใช้ซอฟต์แวร์)

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

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

การย้ายไปยังเอกสารเฉพาะเพิ่มเติมหากคุณต้องการทำงานกับแหล่งข้อมูลสำหรับโครงการต่าง ๆตรวจสอบให้แน่ใจว่าคุณได้ตั้งค่าสภาพแวดล้อมการพัฒนาที่เหมาะสม ! สำหรับรายการตรวจสอบสิ่งที่คุณควรมี:

• การควบคุมเวอร์ชัน ( git , mercurial , fossil )
• การติดตามข้อผิดพลาด ( trac , ตั๊กแตนตำข้าว , redmine , ฟอสซิล )
• สร้างระบบ ( autotools , scons , buildbot )
• การควบคุมโครงการ ( eclipseโครงสร้างไดเรกทอรีที่ระบุปลั๊กอินตัวแก้ไข )
• เอกสารต้นฉบับ (README, TODO, INSTALL, ความคิดเห็นต้นฉบับ)

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

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

แก้ไข:

ตามความคิดเห็นของอุปกรณ์ต่อไปนี้สิ่งที่ต้องทำอีกอย่างคือการสร้างไดอะแกรมของซอร์สโค้ด Freecode มีเนื้อหาและบทความนี้มีรายการบางรายการสำหรับภาษายอดนิยม

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

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

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

โชคดี!

เมื่อฉันพยายามบันทึกสิ่งที่คนอื่นที่ไม่ได้อยู่ในโครงการหรือ บริษัท ทำฉันมักจะเริ่มทัศนคติของ: นี่คือกล่องดำให้กับทุกคนรวมถึงฉันจนกว่าฉันจะต้องเปลี่ยนอะไรบางอย่างหรืออธิบายให้คนอื่น

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

คุณสามารถเขียนการทดสอบเชิงสำรวจอัตโนมัติ สิ่งเหล่านี้มีข้อดีหลายประการ:

• คุณเรียนรู้วิธีการทำงานของระบบในขณะที่เขียน

• พวกเขาทำหน้าที่เป็นเอกสารที่ปฏิบัติการได้สำหรับในภายหลัง

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

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