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