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