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

ปิด คำถามนี้เป็นคำถามความคิดเห็นตาม ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบข้อเท็จจริงและการอ้างอิงได้โดยแก้ไขโพสต์นี้ ปิดให้บริการใน6 ปีที่ผ่านมา เป้าหมายคือการมีระบบเอกสารออนไลน์ด้วยข้อกำหนดที่สำคัญเหล่านี้: ส่วนใหญ่จะใช้เป็นระยะกลางสำหรับเอกสารทางเทคนิคขั้นสุดท้ายของแอปพลิเคชันทั้งหมดของเรา (ซึ่งอาจจะไม่เสร็จสมบูรณ์แม้ว่า:]) โดยทั่วไปจะใช้เป็นเช่นนั้น: ใครบางคนมีปัญหาฉันจะแก้ไขและเขียนการแก้ไขทันที สิ่งที่เกิดขึ้นตอนนี้เริ่มไม่สามารถจัดการได้: ใครบางคนมีปัญหาฉันจะแก้ไขมันทั้งฉันและคนที่มีความสุข แต่ 2 เดือนต่อมาคนอื่นมีปัญหาเดียวกันและไม่มีใครจำได้ว่าการแก้ไขคืออะไร สามารถเข้าถึงได้จากทุกที่ทำงานอยู่ด้านหลังเซิร์ฟเวอร์ apache ของเรา การจัดการผู้ใช้ / กลุ่มอนุญาตการเข้าถึงแบบอ่านอย่างเดียว / อ่าน - เขียน / ผู้ดูแลระบบ รูปแบบไม่สำคัญเกินไป: ข้อความธรรมดาจะทำวิกิสไตล์จะดีกว่า ราคาถูกหรือฟรี ความคิดบางอย่างของฉัน: เพียงแค่ให้บริการไฟล์ในการแชร์ไฟล์หรือผ่าน ssh (ข้อเสีย: ไม่สามารถใช้ร่วมกับ windows ได้ข้อดี: ง่ายสามารถเป็นไฟล์ประเภทใดก็ได้) เก็บไว้ใน SCM (svn / git, idem ข้างต้น แต่ง่ายต่อการเข้าถึงและควบคุมการเข้าถึง) การบรรจบกัน: เราใช้จิราแล้วการบรรจบกันนั้นคุ้มค่าหรือไม่ …

11 documentation 

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

11 agile  documentation  architecture  dry 

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

11 project-management  business  management  documentation 

ซอฟต์แวร์ของเรามีหลายคลาสที่ควรพบแบบไดนามิกผ่านการสะท้อนกลับ คลาสทั้งหมดมีคอนสตรัคเตอร์ที่มีลายเซ็นเฉพาะซึ่งรหัสการสะท้อนจะทำให้วัตถุเป็นอินสแตนซ์ อย่างไรก็ตามเมื่อมีคนตรวจสอบว่ามีการอ้างอิงวิธีการนั้นหรือไม่ (เช่นผ่าน Visual Studio Code Lens) การอ้างอิงผ่านการสะท้อนกลับจะไม่ถูกนับ ผู้คนสามารถพลาดการอ้างอิงและลบ (หรือเปลี่ยน) วิธีที่ไม่ได้ใช้อย่างเห็นได้ชัด เราควรทำเครื่องหมาย / วิธีการเอกสารที่ต้องการเรียกผ่านการสะท้อนอย่างไร เป็นการดีที่ควรทำเครื่องหมายวิธีในลักษณะที่ทั้งเพื่อนร่วมงานและ Visual Studio / Roslyn และเครื่องมืออัตโนมัติอื่น ๆ 'ดู' ว่าวิธีการมีวัตถุประสงค์ที่จะเรียกว่าผ่านการสะท้อน ฉันรู้ว่ามีสองตัวเลือกที่เราสามารถใช้ได้ แต่ทั้งคู่ไม่ค่อยพอใจ เนื่องจาก Visual Studio ไม่พบการอ้างอิง: ใช้แอตทริบิวต์ที่กำหนดเองและทำเครื่องหมายตัวสร้างด้วยคุณลักษณะนี้ ปัญหาคือคุณสมบัติของแอททริบิวไม่สามารถเป็นการอ้างอิงเมธอดได้ดังนั้นตัวสร้างจะยังคงแสดงว่ามีการอ้างอิง 0 รายการ เพื่อนร่วมงานที่ไม่คุ้นเคยกับแอตทริบิวต์ที่กำหนดเองอาจจะเพิกเฉย ข้อดีของวิธีการปัจจุบันของฉันคือส่วนการสะท้อนสามารถใช้คุณลักษณะเพื่อค้นหาตัวสร้างที่ควรเรียกใช้ ใช้ความคิดเห็นเพื่อจัดทำเอกสารว่าเมธอด / คอนสตรัคเตอร์ตั้งใจที่จะเรียกผ่านการสะท้อนกลับ เครื่องมืออัตโนมัติไม่สนใจความคิดเห็น (และเพื่อนร่วมงานก็ทำได้เช่นกัน) ความคิดเห็นเกี่ยวกับเอกสาร XMLสามารถนำมาใช้เพื่อให้ Visual Studio นับการอ้างอิงเพิ่มเติมถึงวิธีการ / คอนสตรัคเตอร์: อนุญาตให้MyPluginคลาสที่ตัวสร้างเรียกใช้ผ่านการสะท้อนกลับ สมมติว่าโค้ดการสะท้อนที่กล่าวอ้างค้นหาคอนสตรัคเตอร์ที่รับintพารามิเตอร์ …

11 c#  .net  documentation  reflection 

เมื่อฉันเขียนสคริปต์ขนาดเล็กสำหรับตัวเองฉันสแต็ครหัสของฉันสูงด้วยความคิดเห็น (บางครั้งฉันแสดงความคิดเห็นมากกว่าฉันรหัส) ผู้คนจำนวนมากที่ฉันพูดคุยเพื่อบอกว่าฉันควรจะบันทึกสคริปต์เหล่านี้แม้ว่าพวกเขาจะเป็นส่วนตัวดังนั้นถ้าฉันจะขายพวกเขาฉันจะพร้อม แต่ไม่ได้แสดงความคิดเห็นในรูปแบบของเอกสารใช่หรือไม่ จะไม่นี้: $foo = "bar"; # this is a comment print $foo; # this prints "bar" ได้รับการพิจารณาเอกสารโดยเฉพาะอย่างยิ่งหากนักพัฒนาซอฟต์แวร์กำลังใช้รหัสของฉันหรือไม่ หรือเอกสารประกอบนั้นถูกพิจารณาว่าอยู่นอกรหัสหรือไม่

11 documentation  comments 

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

11 unit-testing  documentation 

เราสร้างห้องสมุดเชิงพาณิชย์และตัวอย่างรหัสที่ผู้พัฒนาภายนอกใช้ เรามีเอกสาร (ปิดให้บริการสำหรับผู้ใช้ที่ลงทะเบียน) ซึ่งอธิบายวิธีการใช้ห้องสมุดอย่างกว้างขวาง นักพัฒนาหลายคนเป็นผู้ใช้ครั้งแรกดังนั้นจึงพบข้อผิดพลาดพื้นฐานมากมาย เหมาะสมหรือไม่ที่จะรวมลิงค์ไปยังเอกสารในบันทึกข้อผิดพลาด? ข้อเสียที่เป็นไปได้คืออะไร? ฉันสามารถคาดการณ์บางอย่าง แต่มันเป็นไปได้ที่จะเอาชนะต่อไปนี้ URL เอกสารคู่มือล้าสมัย ข้อผิดพลาดเฉพาะรุ่นที่ไม่ปรากฏในเอกสารล่าสุด มีบางอย่างผิดปกติและเรากำลังเสียเวลาของผู้พัฒนาโดยส่งเขาไปยังเอกสารที่ไม่เกี่ยวข้อง ด้านล่างเป็นตัวอย่างของสิ่งที่ฉันหมายถึงมันเป็นความคิดที่ดีที่จะเพิ่มข้อความหนา? [ข้อผิดพลาด] ล้มเหลวในการดำเนินการเป้าหมาย org.apache.maven.plugins: maven-archetype-plugin: 1.2.3: สร้าง (default-cli) ในโครงการ standalone-pom: archetype ที่ต้องการไม่มีอยู่ (com.example.library ต้นแบบ: library-archetype-blank: 1.2.3.0) -> โปรดดูhttp://example.com/docs/setting-up-an-archetypeสำหรับข้อมูลเพิ่มเติมและการแก้ไขปัญหาที่เป็นไปได้

10 documentation  api-design  error-handling  error-messages 

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

10 architecture  documentation 

ฉันเป็นผู้พัฒนาเพียงผู้เดียวในโครงการที่อาจมีคนอื่นนำไปใช้ในโครงการต่อไปในอนาคต สมมติว่าฉันใช้รูปแบบ X เพื่อใช้คุณสมบัติ A หลังจากพัฒนาและทำให้คุณลักษณะเสร็จสมบูรณ์ฉันรู้ว่าฉันสามารถใช้คุณสมบัติเดียวกันโดยใช้รูปแบบ Y ซึ่งฉันเพิ่งเรียนรู้มา แต่ฟีเจอร์ A ทำงานได้ดีและการเปลี่ยนจาก X เป็น Y นั้นใช้เวลานานและให้ประโยชน์เล็กน้อย จากนั้นก็ถึงเวลาที่จะใช้งานคุณสมบัติ B มันคล้ายกับ A แต่คราวนี้ฉันต้องการใช้โอกาสนี้เพื่อเล่นกับรูปแบบ Y ฉันมีความสุขกับผลลัพธ์สุดท้ายดีกว่าเมื่อใช้คุณสมบัติ A แต่ตอนนี้โค้ดของฉันใช้สอง รูปแบบที่ต่างกัน, X และ Y, สำหรับคุณสมบัติที่คล้ายกัน แต่ไม่มีเหตุผลที่แท้จริงที่จะใช้รูปแบบที่แตกต่างกันยกเว้นความจริงที่ว่าเมื่อการสร้างฟีเจอร์ AI นั้นไม่ชำนาญพอที่จะใช้รูปแบบเดียวกันกับฟีเจอร์ B โปรดทราบว่าคำถามนี้ไม่ได้เกี่ยวกับการเลือกรูปแบบที่เหมาะสมสำหรับปัญหาที่กำหนด ; มันมีอยู่สองรูปแบบที่อยู่ร่วมกันในฐานของรหัสเพื่อแก้ปัญหาที่คล้ายกันซึ่งสามารถลดลงเหลือเพียงครั้งเดียวเพื่อให้มีการปรับโครงสร้าง รหัสนั้นมีกลิ่นหรือไม่? อะไรคือข้อเสียของการรักษาซอร์สโค้ดเช่นนี้? ฉันควรจะใช้รูปแบบเดียวเท่านั้นหรือไม่ เช่น refactor A เพื่อใช้ Y หรือใช้ X ต่อไปเมื่อเขียน B? ฉันจะสื่อสารได้อย่างไรว่าสาเหตุที่มีสองรูปแบบที่แตกต่างกันสำหรับคุณสมบัติที่คล้ายกันนั้นไม่มีเหตุผล ฉันกังวลมากเกินไปเกี่ยวกับสิ่งที่นักพัฒนาคนต่อไปคิดเกี่ยวกับรหัสของฉันหรือไม่

10 design-patterns  refactoring  documentation 

คุณคาดหวังว่าจะเห็นข้อมูลใดใน GitHub README? ทุกอย่างควรไปใน README หรือไม่ กล่าวคือ บทนำ การติดตั้ง รุ่น คู่มือผู้ใช้ การดำเนินงาน การทดสอบ แหล่งข้อมูลที่เกี่ยวข้อง หรือคุณเพียงแค่ใส่บางสิ่งลงใน README (บทนำ, การติดตั้ง, เวอร์ชั่น) และข้อมูลอื่น ๆ ที่ดีที่สุดใน Github wiki?

10 documentation  github 

ฉันเคยเป็นแฟนที่ต้องการแสดงความคิดเห็น XML สำหรับเอกสาร ฉันเปลี่ยนใจเนื่องจากเหตุผลหลักสองข้อ: เช่นเดียวกับรหัสที่ดีวิธีการควรอธิบายด้วยตนเอง ในทางปฏิบัติความคิดเห็น XML ส่วนใหญ่เป็นเสียงที่ไร้ประโยชน์ซึ่งไม่มีค่าเพิ่มเติม หลายครั้งที่เราใช้ GhostDoc เพื่อสร้างความคิดเห็นทั่วไปและนี่คือสิ่งที่ฉันหมายถึงด้วยเสียงไร้ประโยชน์: /// <summary> /// Gets or sets the unit of measure. /// </summary> /// <value> /// The unit of measure. /// </value> public string UnitOfMeasure { get; set; } สำหรับฉันนั่นชัดเจน ต้องบอกว่าถ้ามีคำแนะนำพิเศษที่จะรวมแล้วเราควรใช้ความเห็น XML อย่างแน่นอน ฉันชอบข้อความที่ตัดตอนมาจากบทความนี้ : บางครั้งคุณจะต้องเขียนความคิดเห็น แต่ควรเป็นข้อยกเว้นไม่ใช่กฎ ความคิดเห็นควรใช้เมื่อแสดงสิ่งที่ไม่สามารถแสดงในรหัสได้ หากคุณต้องการเขียนโค้ดที่หรูหราให้พยายามกำจัดความคิดเห็นและเขียนรหัสเอกสารเอง ฉันผิดที่คิดว่าเราควรใช้ความคิดเห็น …

10 .net  programming-practices  development-process  documentation  comments 

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

10 agile  documentation  requirements  user-story 

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

10 documentation 

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

10 documentation  training 

ฉันแสดงของรหัสเอกสารอย่างถูกต้องและผมตระหนักดีถึงข้อเสียเป็นไปได้ของมัน นั่นอยู่นอกขอบเขตของคำถามนี้ ฉันชอบที่จะปฏิบัติตามกฎของการเพิ่มความคิดเห็น XMLสำหรับสมาชิกสาธารณะทุกคนพิจารณาว่าฉันชอบ IntelliSense ใน Visual Studio มากแค่ไหน มีรูปแบบหนึ่งของความซ้ำซ้อนซึ่งแม้กระทั่งผู้วิจารณ์ที่มากเกินไปอย่างฉันก็ใส่ใจด้วย ตัวอย่างเช่นใช้List.Exists () /// <summary> /// Determines whether the List<T> contains elements /// that match the conditions defined by the specified predicate. /// </summary> /// <returns> /// true if the List<T> contains one or more elements that match the /// conditions …

10 documentation  comments  intellisense