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

4
หมายเลขโทรศัพท์ของ example.org คืออะไร
RFC 2606มาตรฐานขอสงวนชื่อโดเมนexample.org , example.netและexample.comเพื่อจุดประสงค์ในการใช้เป็นตัวอย่างในเอกสารประกอบ หมายเลขโทรศัพท์ (รวมถึงรหัสประเทศ) ที่เทียบเท่ากับอะไรที่สามารถใช้เป็นตัวอย่างเช่นการให้ผู้ใช้ตัวอย่างในรูปแบบที่จะป้อนหมายเลขโทรศัพท์ ในกรณีที่ดีที่สุดมันจะเป็นหมายเลขจำลองที่กำหนดโดยมาตรฐานที่เกี่ยวข้องเพื่อเป็นตัวอย่างหมายเลขโทรศัพท์และจะไม่นำมาประกอบกับผู้สมัครสมาชิกจริง

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

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