คำถามติดแท็ก documentation

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

13 project-management  version-control  development-process  documentation  builds 

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

13 design  documentation 

ฉันต้องการทราบว่ามีตัวเลือกใดบ้างสำหรับการจัดทำเอกสารโครงการที่ได้รับการพัฒนาแล้วเนื่องจากผู้พัฒนาที่ทำงานบนไม่ได้เขียนเอกสารแม้แต่หน้าเดียว โครงการนี้ไม่มีรายละเอียดอื่นใดนอกจากหน้าของสคริปต์ที่มีหน้าที่เขียนและแก้ไขโดยนักพัฒนาที่ทำงานในโครงการนี้ในช่วง 2 ปีที่ผ่านมา สิ่งที่ฉันมีก็คือสคีมาฐานข้อมูลและไฟล์โครงการ ฉันต้องการทราบว่ามีวิธีใดที่จะจัดระเบียบโครงการนี้และจัดทำเอกสารเพื่อที่จะเป็นประโยชน์สำหรับนักพัฒนาที่จะทำงานกับโครงการนี้ในอนาคต โครงการได้รับการพัฒนาด้วย PHP และ MySQL ฟังก์ชั่นนั้นมีความคิดเห็นไม่ดีดังนั้นฉันจึงไม่สามารถรับผลลัพธ์ที่ดีได้เมื่อฉันเรียกใช้ด้วย doxygen

13 project-management  documentation 

ฉันมีฐานข้อมูล MongoDB ที่ฉันต้องการเอกสารการออกแบบสคีมาอย่างถูกต้อง ฉันรู้ว่า MongoDB เป็นฐานข้อมูล NoSQL และเป็น schemaless ตามธรรมชาติ แต่ฉันบังคับใช้ schema ผ่านแอปพลิเคชันของฉันและฉันต้องการที่จะเป็นตัวแทนในวิธีที่ดีกว่าการพิมพ์findOne()ผลลัพธ์ ฉันเห็นคนจำนวนมากที่ใช้ ER หรือ UML แต่ฉันไม่รู้สึกว่าเป็นแนวคิดที่ถูกต้องในการแสดงฐานข้อมูล NoSQL ของฉันเป็นฐานข้อมูลเชิงสัมพันธ์หรืออย่างน้อยก็ดูแปลก ตัวอย่างการใช้ UML: MongoDB: จะแสดงไดอะแกรมสคีมาในวิทยานิพนธ์ได้อย่างไร ฉันคิดว่าผู้คนจะใช้โมเดลที่แตกต่างกัน ฉันค้นหาแล้วและไกลที่สุดเท่าที่ฉันเคยเห็นคือMongoVUEที่เสนอมุมมองแบบต้นไม้ที่ดีเพื่อทำความเข้าใจกับสคีมา แต่มันไม่เป็นมิตรกับเครื่องพิมพ์ มีอย่างอื่นที่ฉันขาดหายไปสำหรับโลก NoSQL หรือไม่? หรือฉันควรพักผ่อนและติดกับ UML แบบดั้งเดิม?

13 documentation  uml  nosql  mongodb  diagrams 

ปิด คำถามนี้ต้องการรายละเอียดหรือความคมชัด ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ เพิ่มรายละเอียดและชี้แจงปัญหาโดยแก้ไขโพสต์นี้ ปิดให้บริการใน4 ปีที่แล้ว RFC : Request for Comments (RFC) เป็นบันทึกที่เผยแพร่โดย Internet Engineering Task Force (IETF) ที่อธิบายวิธีการพฤติกรรมการวิจัยหรือนวัตกรรมที่ใช้กับการทำงานของอินเทอร์เน็ตและระบบที่เชื่อมต่ออินเทอร์เน็ต ในตอนท้ายของวิดีโอ Intro to RESTนี้RFC2616และRFC3986ถูกกล่าวถึงเป็นการอ่านเพิ่มเติม หลังจากดูวิดีโอฉันได้รวบรวมเอกสารเหล่านั้นและตามที่ชื่อแนะนำฉันไม่แน่ใจว่าจะใช้อย่างไร ฉันอ่านพวกเขาอย่างครบถ้วนและจดบันทึกหรือฉันจะใช้พวกเขามากขึ้นเพื่อเป็นข้อมูลอ้างอิงเมื่อฉันไม่เข้าใจอะไรหรือมีปัญหาหรือไม่?

12 learning  documentation 

ฉันเป็นนักพัฒนาซอฟต์แวร์ที่ทำงานใน บริษัท ระบบฝังตัว เรามีผู้จัดการโครงการที่ดูแลกำหนดการโครงการโดยรวม (รวมถึงไฟฟ้าคุณภาพซอฟต์แวร์และการผลิต) ดังนั้นกำหนดการซอฟต์แวร์ของเขาจึงสั้นมาก เรายังมีผู้จัดการซอฟต์แวร์ซึ่งเป็นหัวหน้าของฉัน เขาทำให้ฉันเขียนและบำรุงรักษากำหนดการซอฟต์แวร์เอกสารการออกแบบ (การออกแบบระดับสูงและต่ำ) SRS การจัดการการเปลี่ยนแปลงแผนการตรวจสอบและรายงานการจัดการการเปิดตัวการทบทวนและหลักสูตรซอฟต์แวร์ เรามีวิศวกรทดสอบเพียงคนเดียวสำหรับทีมซอฟต์แวร์ทั้งหมด (สมาชิก 10 คน) และในเวลาใดก็ตามมีโครงการสองโครงการเกิดขึ้น ฉันใช้เวลา 80% ในการทำเอกสารเหล่านี้ เจ้านายของฉันมาจากพื้นฐานกระบวนการและเชื่อว่าสิ่งที่เราต้องการคือเอกสารที่ดีกว่าในการปรับปรุงซอฟต์แวร์: เขาคิดว่าการออกแบบเป็นสิ่งสำคัญยิ่งการเข้ารหัสคือ "เพียงแค่เขียนการออกแบบ" มันไม่ควรใช้เวลานานเกินไปและ "รหัสทั้งหมดควรจะเขียนก่อนที่ฮาร์ดแวร์จะพร้อม" ไม่เข้าใจความแตกต่างระหว่างตัวควบคุม Central & Distributed Version แม้ว่าเราจะบอกเขาว่ามันง่ายกว่าที่จะทำงานร่วมกับแบบจำลองการกระจาย ไม่เข้าใจรหัสและต้องการเข้าใจทุกข้อบกพร่องและแนวทางแก้ไขที่เสนอ การตรวจสอบความเชื่อควรทำโดยนักพัฒนาและการตรวจสอบโดยผู้ทดสอบ สิ่งที่เป็นอยู่การตรวจสอบของเราเพียงตรวจสอบว่าการใช้งานถูกต้อง (เราไม่ได้เขียนการทดสอบหน่วยมันไม่เคยพิจารณาในตาราง) และการตรวจสอบคือการทดสอบกล่องดำดังนั้นการทดสอบหน่วยจะหายไป ฉันสับสนจริงๆ ฉันต้องรับผิดชอบในการดูแลรักษาเอกสารเหล่านี้ทั้งหมดหรือไม่ มันทำให้ฉันรู้สึกว่าฉันกำลังทำ Software Management Management เป็นหลัก ฉันใช้ได้กับเอกสารทางเทคนิค แต่ฉันเชื่อว่านักพัฒนาไม่ควรทำตามกำหนดเวลา / การวางแผน ฉันไม่ชอบการสร้างเอกสารฉันต้องการแก้ปัญหาและเขียนรหัส จากประสบการณ์ของฉันการสร้างเอกสารการออกแบบจะช่วยเท่าที่ไม่เคยแก้ปัญหาของรหัสที่ดีขึ้นหรือเร็วขึ้น ฉันรู้สึกว่าเจ้านายไม่ได้ใส่ใจกับการสร้างผลิตภัณฑ์ที่ดีกว่า แต่เกี่ยวกับการเป็นผู้จัดการที่ดีในสายตาของผู้บริหาร …

12 design  project-management  development-process  documentation 

มีคำที่ดีที่คล้ายกัน แต่แตกต่างจาก "คัดค้าน" เพื่อหมายความว่าวิธีการหรือ API อยู่ในรหัสฐาน แต่ไม่ควรใช้เนื่องจากการใช้งานไม่สมบูรณ์หรือมีแนวโน้มที่จะเปลี่ยนแปลง? (ใช่ฉันรู้วิธีการเหล่านั้นไม่ควรเปิดเผยต่อสาธารณชน yada yada yada ฉันไม่ได้สร้างสถานการณ์ของฉันฉันแค่พยายามทำให้ดีที่สุดเท่าที่จะทำได้) ผู้คนแนะนำอะไร ทดลองไม่สมบูรณ์มีอะไรอีกหรือ หากฉันกำลังสร้างเอกสาร javadoc สำหรับ API นี้ที่ยังอยู่ในฟลักซ์ฉันควรใช้แท็ก @deprecated หรือมีข้อตกลงที่ดีกว่า สำหรับฉัน @deprecated แสดงว่า API นี้เก่าและมีกลไกที่ต้องการที่ใหม่กว่าพร้อมใช้งาน ในสถานการณ์ของฉันไม่มีทางเลือก แต่วิธีการบางอย่างใน API ยังไม่เสร็จสิ้นและไม่ควรใช้ ณ จุดนี้ฉันไม่สามารถทำให้พวกเขาเป็นส่วนตัว แต่ฉันต้องการที่จะใส่คำเตือนที่ชัดเจนในเอกสาร

12 documentation  terminology  api  documentation-generation  javadocs 

ที่สำคัญเรายังมีปัญหาไม่ว่ากรณีใด ๆ กับเอกสารรหัสแหล่งที่มา นี่เป็นของการตรวจสอบรหัสปกติและได้รับการปรับปรุงให้ทันสมัยอยู่เสมอ ปัญหาของเราคือเอกสารประกอบสำหรับนักพัฒนา (หรือ "ภายนอก" หากคุณต้องการ) เคล็ดลับเล็ก ๆ น้อย ๆ เช่นบล็อกจากโปรแกรมเมอร์ถึงโปรแกรมเมอร์ซึ่งมักจะเขียนครั้งเดียวมักจะถูกทิ้งไว้ข้างหลัง เราใช้ระบบคล้ายวิกิเพื่อจัดทำเอกสารโปรแกรมเมอร์ - บทความที่เขียนโดยโปรแกรมเมอร์สำหรับโปรแกรมเมอร์อธิบายในรายละเอียดเพิ่มเติมเล็กน้อยว่าชิ้นส่วนของรหัสทำงานอย่างไร หน้าวิกิเหล่านั้นมักจะรวมถึง: แรงจูงใจที่อยู่เบื้องหลังการตัดสินใจออกแบบสำหรับส่วนต่างๆของ API (ตัวอย่างเช่นเราทำสิ่งนี้น่าเกลียดเพราะห้องสมุดบุคคลที่สามนี้ต้องการให้ทำสิ่งนี้ด้วยวิธีนี้เพราะห้องสมุดอื่นนี้ ... เพราะ ... คำอธิบายเกี่ยวกับวิธีที่เราจัดการกับงานทั่วไปโดยเฉพาะ (ตัวอย่างเช่นการแสดงป๊อปอัปเล็กน้อยซึ่งจำเป็นต้องอ้างอิงรูปแบบแอปพลิเคชันที่เหมาะสมลงทะเบียนในองค์ประกอบของรีจิสทรีและใช้อินเทอร์เฟซบางอย่างเพื่อสแกนโดยอัตโนมัติ การปฏิบัติที่ดี (ส่วนตัวเหมือนเดิมเราเขียนสิ่งนี้ลงไป) การกำหนดค่าสภาพแวดล้อมเครื่องมือที่จำเป็นและการตั้งค่า โดยทั่วไปแล้วสิ่งที่เกี่ยวข้องกับการเขียนโค้ดที่ไม่เหมาะกับรหัสเอกสารทั่วไปเนื่องจากขนาดและลักษณะของบล็อก / บทความที่คล้ายกัน ปัญหา เท่าที่การแนะนำระบบนี้ดูเหมือนจะเป็นความคิดที่ดีไม่กี่เดือนที่ผ่านมาทุกวันนี้ฉันรู้สึกว่ามันทำให้เกิดปัญหามากกว่าที่จะแก้ ตัวอย่างเช่น: คนทำบทความเขียน ... แต่เมื่อเปลี่ยนรหัสปรับปรุงวิกิพีเดียไม่ค่อยดังต่อไปนี้ มีบทความเกี่ยวกับรอยขีดข่วนจำนวนมากเขียนโดยใครบางคนที่รีบร้อนและทิ้งไว้เช่นนั้น แม้ว่าโดยปกติแล้วการร้องขอบทความจะมาจากผู้นำโครงการ แต่ก็ไม่ค่อยมีการตรวจสอบความถูกต้อง / องค์ประกอบซึ่งบางครั้งอาจส่งผลให้มีคุณภาพไม่ดี ความเสื่อมโทรมตามปกติ รหัสมีการเปลี่ยนแปลงวิกิยังคงเหมือนเดิม ครั้งต่อไปที่มีคนค้นหาข้อมูลสิ่งที่เขามักจะพบคือสิ่งของที่ล้าสมัยและมีคุณภาพต่ำ - และกำลังสงสัยว่าเกิดอะไรขึ้นไม่ว่าจะเป็นสิ่งที่เขาพบว่ามีความถูกต้องหรือ (แย่ยิ่งกว่า) ส่วนใดของมัน และสิ่งที่ควรจะช่วยจบลงด้วยการทำตรงกันข้าม …

12 project-management  agile  documentation 

เมื่อเราพูดว่า 'เอกสาร' สำหรับผลิตภัณฑ์ซอฟต์แวร์สิ่งที่รวมอยู่และสิ่งที่ไม่ควรมี ตัวอย่างเช่นคำถามล่าสุดถามว่าความคิดเห็นได้รับการพิจารณาเป็นเอกสารประกอบหรือไม่ แต่มีหลายพื้นที่อื่น ๆ ที่เป็นคำถามที่ถูกต้องเช่นกันบางอย่างชัดเจนกว่าคนอื่น: คู่มือ (ชัด) บันทึกประจำรุ่น สอน ความคิดเห็น คนอื่น ๆ ? วาดเส้นตรงไหน ตัวอย่างเช่นหากเอกสารประกอบ 'กวดวิชา' เป็นเอกสาร 'วิดีโอสอน' หรือเป็นอย่างอื่น โดยทั่วไปแล้วบางสิ่งในซอฟต์แวร์จะไม่ 'เสร็จสิ้น' จนกว่าจะมีการใช้งานทดสอบและจัดทำเอกสาร ดังนั้นคำถามนี้เราควรพิจารณาสิ่งใดบ้างในฐานะส่วนหนึ่งของเอกสารประกอบเพื่อพิจารณาบางสิ่งที่ 'ทำ' คำถามสร้างแรงบันดาลใจจากคำติชมของลูกค้าเมื่อไม่นานมานี้ในการประชุมของเราแสดงให้เห็นว่าเอกสารของเราต้องการ 'ตัวอย่าง' มากขึ้นซึ่งก่อนหน้านี้เราไม่เคยคิดจะพิจารณาเท่าที่ควร ผู้ชม: นักพัฒนาซอฟต์แวร์โดยใช้ฐานข้อมูลของเราภาษาการเขียนโปรแกรมและเครื่องมือที่เกี่ยวข้อง (เช่นผู้ดูแลระบบลูกค้าเพื่อบอกว่า DB)

12 documentation  terminology 

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

12 documentation  maintenance  knowledge-transfer 

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

12 documentation  definition 

ขณะนี้เราใช้ระบบที่ชื่อว่าAsciiDocซึ่งทำให้เราสามารถสร้างเอกสารในมาร์กอัปข้อความธรรมดา จากนั้นเราสามารถสร้างรูปแบบเอาต์พุตหลายรูปแบบ เราใช้ประโยชน์จากรูปแบบไฟล์ PDF เอาต์พุตและ chm เท่านั้น ฉันสงสัยว่าถ้ามีทางเลือกให้ chm? สิ่งที่ฉันกำลังมองหาคือสิ่งที่สามารถใช้งานแบบออฟไลน์ได้ (สิ่งนี้สำคัญเนื่องจากผู้ใช้ของเราจำนวนเล็กน้อยอยู่ในสถานที่ห่างไกล) ด้วยซอฟต์แวร์ของเรา ควรมีดัชนี (สามารถทำได้ง่ายเหมือนหน้า html ที่มีคำไฮเปอร์ลิงก์) ควรค้นหาได้และควรมีกลไกที่อนุญาตให้มีการเรียกรายการเฉพาะจากรหัส (คล้ายกับวิธีใช้ตามบริบท) สองสิ่งที่ขัดแย้งกับ PDF ในกรณีนี้คือ: ความช่วยเหลือที่มีความละเอียดอ่อนตามบริบทไม่ใช่ตัวเลือก โดยทั่วไปแล้วเอกสารมีขนาดค่อนข้างใหญ่ PDF เหมาะสมกับเอกสารที่พิมพ์มากกว่าวิธีใช้แบบตามบริบท สิ่งที่ฉันต้องการคือการใช้ html ปัญหาเดียวของ html คือฉันไม่สามารถหาวิธีให้การค้นหาคำหลักได้โดยอัตโนมัติ (นอกเหนือจากฟังก์ชัน ctrl + f ของเบราว์เซอร์ - ฉันต้องการสิ่งที่ชัดเจนกว่า) ฉันไม่สามารถหาวิธีในการสร้างดัชนีไฮเปอร์ลิงก์ของคำสำคัญได้โดยอัตโนมัติ ความช่วยเหลือที่ละเอียดอ่อนตามบริบทนั้นง่ายเนื่องจากแท็กส่วน - ฉันสามารถส่ง URL ของหน้าและส่วนที่ฉันสนใจในเบราว์เซอร์เริ่มต้นและหน้านั้นควรโหลดจนถึงส่วนที่ถูกต้อง ความต้องการของฉันฟังดูแย่มากเหมือน chm - พวกเขาทำ ฉันทำแบบจำลองตามข้อกำหนดของฉัน เหตุผลเดียวที่ฉันไม่ชอบ chm …

12 documentation  html  help-documentation 

ปิด คำถามนี้จะต้องมีมากขึ้นมุ่งเน้น ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้มุ่งเน้นที่ปัญหาเดียวโดยแก้ไขโพสต์นี้ ปิดให้บริการใน6 ปีที่ผ่านมา ฉันเป็นผู้สร้างโครงการโอเพ่นซอร์สที่กำลังเติบโต ขณะนี้ฉันกลายเป็นคนโง่พยายามที่จะหาวิธีที่ดีที่สุดในการจัดการเอกสาร นี่คือตัวเลือกที่ฉันได้พิจารณา: เว็บไซต์ HTML A Github Wiki ไฟล์ Markdown ที่โฮสต์บน Github การวางเอกสารทั้งหมดใน Github README.md เอกสารถูกเขียนเป็น Markdown แล้วฉันไม่สามารถเข้าใจได้ว่าฉันต้องการให้มันพร้อมใช้งานอย่างไร ฉันชอบ Git มากเพราะฉันสามารถแยกและแท็กเอกสารได้เหมือนกับที่ฉันสามารถแยกและแท็กแหล่งที่มา ฉันสามารถใช้ห้องสมุด Markdown เพื่อแปล Markdown เป็น HTML และแสดงบนเว็บไซต์ที่มีสไตล์ ฉันจะต้องอัปโหลดการเปลี่ยนแปลงไปยังเว็บไซต์เมื่อใดก็ตามที่มีการเปลี่ยนแปลงและมันยากที่จะจัดการ "แท็ก" ที่แตกต่างกันทั้งหมดของเอกสาร Github Wikis (เท่าที่ฉันรู้) จะไม่เปลี่ยนแปลงไปตามสาขาที่คุณอยู่ ดังนั้นฉันสามารถมีเอกสาร "รุ่นหลัก" ในรูปแบบ Github Wiki ได้ทุกเวลา การใส่ทั้งหมดลงใน Github …

12 open-source  documentation 

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

12 documentation  project  management  requirements 

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

12 experience  documentation  journal