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

W3Schoolsมีชื่อเสียงในด้านความไม่สมบูรณ์บางครั้งไม่ถูกต้องและขี่ด้วยการโฆษณา ยังคงเมื่อมองหาบางสิ่งบางอย่างหรือเชื่อมโยงไปยังเอกสารเมื่อตอบคำถาม SO ก็ยังคงเป็นทรัพยากรข้ามเบราว์เซอร์ที่มีประโยชน์เท่านั้น มีแหล่งข้อมูลอื่น ๆ เช่นที่มีการพัฒนาเครือข่าย Mozillaที่ทำผลงานได้ดีมากขึ้นการจัดเก็บเอกสาร JavaScript และตำนานและดีquirksmode แต่พวกเขาก็ยอดเยี่ยมอย่างที่พวกเขาพูดครอบคลุมเฉพาะบางส่วนของพื้นที่ที่ฉันกำลังพูดถึงและไม่มีตัวเลือกการแก้ไขและการควบคุมคุณภาพในชุมชน มีใครตระหนักถึงความพยายามในการสร้างสารานุกรม HTML / CSS / JavaScript / DOM ข้ามเบราว์เซอร์ที่แก้ไขร่วมกันหรือไม่ ถ้าคุณต้องการฉันกำลังคิดว่าผู้ท้าชิงต่อ W3Schools อย่าง SO คือการแลกเปลี่ยนผู้เชี่ยวชาญ

12 web-development  documentation  html  css 

เรากำลังดูเอกสารการปรับปรุงใหม่ในสายผลิตภัณฑ์ของเรา ส่วนหนึ่งของนั้นรวมถึงคู่มืออ้างอิงสำหรับภาษาการเขียนโปรแกรมที่ใช้เป็นส่วนหนึ่งของระบบ เมื่อเขียนคู่มืออ้างอิงสำหรับภาษาการเขียนโปรแกรมวิธีที่ดีที่สุดในการจัดโครงสร้างเพื่อให้เกิดประโยชน์สูงสุดต่อผู้ที่ใช้ภาษาใหม่คืออะไร? อะไรคือประเด็นสำคัญของคำหลักแต่ละคำที่บันทึกไว้? วากยสัมพันธ์ ลักษณะ อาร์กิวเมนต์ - ถ้ามี ส่งคืนค่า - ถ้ามี ตัวอย่างการใช้งาน? อื่น ๆ ที่ฉันหายไป? แนวคิด (เช่นกลยุทธ์การล็อกรายละเอียดที่เกี่ยวข้องกับประสิทธิภาพ) ควรมีการบันทึกไว้ในคู่มืออ้างอิงนี้หรือไม่หรือเป็นเอกสารแยกต่างหาก นี่คือการบริโภคภายนอก เรามีชุดเอกสารทั้งหมดแล้ว (ดู: http://www.rocketsoftware.com/u2/resources/technical-resources ) ทำงานในสิ่งที่เราควรทำแตกต่าง - ฉันมีความคิดอยู่แล้ว แต่เช่นเคยฉันพยายามไม่พึ่งพาความคิดเห็นของฉัน แต่เพียงผู้เดียว ผู้ชม: นักพัฒนาด้านเทคนิคใช้ฐานข้อมูลและเครื่องมือในการผลิตซอฟต์แวร์ในหลายอุตสาหกรรม

12 programming-languages  documentation 

ปิด คำถามนี้จะต้องมีมากขึ้นมุ่งเน้น ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้มุ่งเน้นที่ปัญหาเดียวโดยแก้ไขโพสต์นี้ ปิดให้บริการใน6 ปีที่ผ่านมา สำหรับโครงการฉันต้องทำงานกับไฟล์ประเภทต่าง ๆ จากเกมเก่า ๆ และซอฟต์แวร์ที่เกี่ยวข้อง - ไฟล์กำหนดค่า, บันทึก, ไฟล์เก็บถาวรทรัพยากรและอื่น ๆ ส่วนใหญ่ของเอกสารเหล่านี้ยังไม่ได้จัดทำเอกสารและไม่มีเครื่องมือใดที่ทำงานร่วมกับพวกเขาได้ดังนั้นฉันต้องย้อนกลับสร้างรูปแบบและสร้างห้องสมุดของตัวเองเพื่อจัดการกับมัน แม้ว่าฉันไม่คิดว่าจะมีความต้องการส่วนใหญ่เป็นอย่างมาก แต่ฉันตั้งใจจะเผยแพร่ผลลัพธ์ของความพยายามของฉัน มีมาตรฐานที่ยอมรับสำหรับรูปแบบไฟล์เอกสารหรือไม่? เมื่อมองไปรอบ ๆ นั้นมีหลายลักษณะที่ใช้งาน: บางอย่างเช่น. ZIP รูปแบบไฟล์สเปคนั้นดูดีมาก คนอื่น ๆ เช่นเดียวกับใน XentaxWiki นั้นเป็นคำศัพท์ที่สั้นกว่ามาก - ฉันพบว่าบางคนอ่านยาก สิ่งที่ฉันชอบที่สุดคือคำอธิบายของระบบไฟล์การ์ดหน่วยความจำของ PlayStation 2ซึ่งมีทั้งข้อความอธิบายรายละเอียดและ 'แผนที่หน่วยความจำ' ที่มีออฟเซ็ตและอื่น ๆ - มันตรงกับกรณีการใช้งานของฉันมากที่สุด มันจะแตกต่างกันเล็กน้อยสำหรับรูปแบบที่แตกต่างกัน แต่ดูเหมือนว่าควรมีหลักการทั่วไปที่ฉันควรลองทำตาม แก้ไข: ฉันดูเหมือนจะไม่ได้อธิบายอย่างดีว่าฉันต้องการทำอะไร ให้ฉันสร้างตัวอย่าง ฉันอาจมีบางส่วนของซอฟต์แวร์เก่าที่เก็บการกำหนดค่าไว้ในไฟล์ 'binary' - …

12 documentation  reverse-engineering 

ฉันสงสัยว่าอะไรจะเป็นวิธีที่เป็นทางการและเป็นวิธีที่ได้รับการฝึกฝนกันมากที่สุดในการทำเอกสารกฎเกณฑ์ทางธุรกิจ คุณจะทำเอกสารข้อกำหนดของ UI ของสิ่งประดิษฐ์เพื่อการพัฒนาได้อย่างไร (เช่นฟิลด์เอกสารแบบฟอร์มและวิธีการทำงานของปุ่มบนฟอร์มข้อความข้อมูล ฯลฯ )

12 documentation  business-rules 

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

11 design  documentation  software  iso 

ปิด. คำถามนี้เป็นคำถามปิดหัวข้อ ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้เป็นหัวข้อสำหรับ Software Engineering Stack Exchange ปิดให้บริการใน6 ปีที่ผ่านมา ฉันเป็นผู้สนับสนุนให้ความเห็นเกี่ยวกับซอร์สโค้ดและการทำเอกสารผลิตภัณฑ์ซอฟต์แวร์ มันเป็นประสบการณ์ส่วนตัวและการสังเกตของฉันว่าการทำงานกับซอร์สโค้ดที่แสดงความคิดเห็นอย่างจริงจังได้ช่วยฉันในรูปแบบที่แตกต่างกันเมื่อฉันต้องเติบโตซอฟต์แวร์หรือบำรุงรักษามัน อย่างไรก็ตามมีอีกค่ายหนึ่งที่กล่าวว่าการแสดงความคิดเห็นนั้นไร้ค่าในที่สุดหรือคุณค่าของมันนั้นน่าสงสัย ผู้เสนอการเข้ารหัสจำนวนมากโดยไม่แสดงความเห็นแย้งว่า: หากโค้ดหนึ่งชิ้นเขียนได้ดีก็จะเป็นการอธิบายตนเองและไม่จำเป็นต้องแสดงความคิดเห็น หากโค้ดหนึ่งชิ้นไม่สามารถอธิบายตัวเองได้ให้ทำการรีแฟคเตอร์ใหม่และทำให้มันอธิบายได้ด้วยตนเองเพื่อที่ว่ามันจะไม่ต้องการความคิดเห็นใด ๆ ชุดทดสอบของคุณคือเอกสารสด เมื่อเวลาผ่านไปรหัสและความคิดเห็นไม่ซิงค์กันและจะกลายเป็นแหล่งที่มาของอาการปวดหัว Agile กล่าวว่ารหัสการทำงานสำคัญกว่ากองเอกสารดังนั้นเราจึงสามารถละเว้นการเขียนความคิดเห็นได้อย่างปลอดภัย สำหรับฉันนี่เป็นเพียงความเชื่อ อีกครั้งการสังเกตส่วนตัวของฉันคือซอฟต์แวร์ที่เขียนโดยทีมนักพัฒนาที่ชาญฉลาดและมีประสบการณ์ท้ายที่สุดก็จบลงด้วยรหัสจำนวนมากที่ไม่ได้อธิบายตัวเอง อีกครั้งที่ Java API, Cocoa API, Android API ฯลฯ แสดงว่าหากคุณต้องการเขียนและดูแลรักษาเอกสารที่มีคุณภาพเป็นไปได้ การพูดถึงสิ่งเหล่านี้การสนทนาเกี่ยวกับข้อดีข้อเสียของการจัดทำเอกสารและการแสดงความคิดเห็นในซอร์สโค้ดที่อิงตามความเชื่อส่วนตัวมักจะไม่จบลงและนำไปสู่ข้อสรุปที่ไม่พึงพอใจ ดังนั้นฉันกำลังมองหาเอกสารทางวิชาการและการศึกษาเชิงประจักษ์เกี่ยวกับผลกระทบของเอกสารประกอบซอฟต์แวร์โดยเฉพาะการแสดงความคิดเห็นซอร์สโค้ดต่อคุณภาพและการบำรุงรักษารวมถึงผลกระทบต่อประสิทธิภาพการทำงานของทีม คุณได้สะดุดกับบทความดังกล่าวและสิ่งที่เป็นผลของพวกเขาถ้ามี?

11 productivity  documentation  code-quality  maintainability  engineering 

มีวิธีปฏิบัติทั่วไปในการแสดงความคิดเห็นนิพจน์ทั่วไปหรือไม่: ความคิดเห็นแบบอินไลน์อ้างอิงส่วนต่าง ๆ ของ RegEx หรือความคิดเห็นทั่วไปสำหรับการแสดงออกทั้งหมด?

11 documentation  coding-style  comments 

ฉันมีโครงการสำหรับมหาวิทยาลัยที่ฉันจะไม่เริ่มต้นในทันที แต่ได้คิดมานานพอสมควรแล้ว ฉันเข้าใจว่าการพัฒนาโครงการของมหาวิทยาลัยไม่เหมือนอุตสาหกรรม (ตอนนี้ฉันฝึกงานด้วยตนเอง) ดังนั้นสถานการณ์ที่ฉันจะชี้ให้เห็นในขณะนี้อาจดูเหมือนไร้สาระกับผู้พัฒนาซอฟต์แวร์จริง ^^' ตัวโครงการเองต้องการให้เราทำเอกสารงานของเรามากมาย ดังนั้นนอกจากการส่งรหัสซึ่งนับรวมเครื่องหมายบางอย่างแล้วเราต้องส่งเอกสารดังนี้: เอกสารวิเคราะห์ความต้องการ แผนโครงการ รายการตามแผนของกรณีการใช้งานวัตถุและโมเดลไดนามิกและการทดสอบการยอมรับ เอกสารขั้นตอนการทดสอบและความสำเร็จของการทดสอบ การอภิปรายและการวิเคราะห์การใช้เวลาอื่น ๆ การส่งมอบเหล่านี้จะต้องจัดส่งในลักษณะดังต่อไปนี้: RAD ก่อน ตามด้วยโครงการโครงการใช้แบบจำลองและการทดสอบ (ประมาณ 3 สัปดาห์ต่อมา) สุดท้ายเอกสารประกอบของโปรแกรมจริงกระบวนการทดสอบ ฯลฯ + โปรแกรมจริง (ประมาณ 5 สัปดาห์ต่อมา) ดังนั้นจากสิ่งที่ฉันเข้าใจนี่คือการมุ่งสู่แนวทางแบบน้ำตกในโครงการ ปัญหาเดียว (ในความคิดของฉัน) คือว่านี่เป็นโครงการของมหาวิทยาลัยและนักเรียนมีแรงกดดันมากพอที่จะพยายามพัฒนาโครงการเมื่อสิ้นสุดภาคการศึกษาในช่วงสัปดาห์ของโครงการ ฉันไม่ต้องการเขียนโค้ด / พัฒนา / ทดสอบทุกอย่างเมื่อสิ้นสุดภาคการศึกษาเมื่อฉันจะตื่นตระหนกกับการประเมินอื่น ๆ อีกมากมายที่ฉันต้องรับมือ อย่างน้อยฉันก็ลองและทำวงจรการพัฒนาแบบวนซ้ำซึ่งหมายความว่าเราสามารถเริ่มต้นการเข้ารหัส / การสร้างต้นแบบตั้งแต่ต้นมีวงจรการพัฒนาอย่างต่อเนื่องที่ไม่ได้มุ่งเน้นที่จะทำทุกอย่างในนาทีสุดท้ายและไม่มีแรงกดดันมากนัก จุดสิ้นสุดของภาคเรียนเพื่อเสร็จสิ้นโครงการนี้ และมาถึงคำถามที่แท้จริงของฉัน: ฉันสามารถตกลงกันได้หรือไม่ว่าจะต้องส่งเอกสารทั้งหมดด้วยวัฏจักรการพัฒนาที่รวดเร็วทำซ้ำ / สร้างต้นแบบ? มีกลยุทธ์ในการสร้างเอกสารในลักษณะวนซ้ำหรือไม่? ฉันไม่มีเหตุผลเลยที่จะขอสิ่งนี้และคาดหวังว่าจะทำได้ในมหาวิทยาลัยหรือไม่? นอกจากนี้ฉันเข้าใจว่าคำถามนี้แปลเป็นภาษาท้องถิ่นอย่างมากดังนั้นฉันจึงอยากถามคำถามแบบเดียวกันกับที่ฉันถามไปข้างต้นในแง่ของอุตสาหกรรมและไม่ว่าจะเป็นปัญหาประเภทใดก็ตามที่กระบวนการเปรียวเผชิญอยู่นั้นแตกต่างกันหรือไม่ …

11 documentation  iterative-development 

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

11 documentation  code-reviews  optimization 

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

11 project-management  documentation  documentation-generation  projects-and-solutions 

ฉันต้องการพัฒนาทักษะการเขียนโปรแกรมของฉันโดยการศึกษาโครงการโอเพ่นซอร์สที่มีชื่อเสียง แต่ฉันคิดว่ามันง่ายที่จะหลงทางโดยเพียงแค่กระโดดลงไปในซอร์สโค้ดของพวกเขา ดังนั้นฉันจึงตัดสินใจที่จะอ่านเอกสารเกี่ยวกับการออกแบบหรือสถาปัตยกรรมของพวกเขา (เช่นแผนภาพ UML) เพื่อให้ได้แนวคิดทั่วไปเกี่ยวกับการจัดระเบียบโค้ดของพวกเขาก่อน ฉันประหลาดใจ แต่ฉันไม่สามารถหาเอกสารทางสถาปัตยกรรมสำหรับโครงการโอเพ่นซอร์สขนาดใหญ่เช่น Hibernate, Spring, ASP.NET MVC, Rails และอื่น ๆ ดังนั้นฉันจึงเริ่มสงสัยว่า: โครงการโอเพ่นซอร์สจะประสบความสำเร็จได้อย่างไรหากนักพัฒนาผู้มาใหม่ไม่มีเอกสารทางสถาปัตยกรรม / การออกแบบที่จะอ่านหรือถ้าผู้จัดการโครงการเพิ่งเปิดซอร์สโค้ด แต่ปิดเอกสาร?

11 open-source  documentation  asp.net-mvc 

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

11 documentation 

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

11 documentation 

ปิด คำถามนี้จะต้องมีมากขึ้นมุ่งเน้น ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้มุ่งเน้นที่ปัญหาเดียวโดยแก้ไขโพสต์นี้ ปิดให้บริการใน4 ปีที่แล้ว ฉันสงสัยอยู่เสมอว่าคุณค้นหาAPI ที่ไม่มีเอกสาร / ส่วนตัวได้อย่างไร ตัวอย่างแอปเปิ้ลที่ไม่มีเอกสาร / API ส่วนตัว, Play Station , Windows Phone 7 , Win32 Kernel , Windows API , การโทรกลับที่ซ่อนอยู่ฯลฯ ... เครื่องมือใดที่แฮ็กเกอร์ใช้เพื่อค้นหาข้อมูลเกี่ยวกับฟังก์ชั่นส่วนตัวและที่ไม่มีเอกสาร? ฉันจะอ่านเกี่ยวกับประสบการณ์ของผู้คนที่เจาะลึกไปถึง API ส่วนตัวและเทคนิควิศวกรรมย้อนกลับที่เปิดเผยความลับที่อธิบายได้ตามปกติในเอกสาร API ได้อย่างไร ขอบคุณ A

11 programming-languages  learning  documentation  api 

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

11 java  c#  c++  documentation  coding-standards