ซอฟต์แวร์เพื่อจัดระเบียบและบำรุงรักษาเอกสารโครงการสเปค? [ปิด]

ฉันกำลังมองหาซอฟต์แวร์เพื่อจัดระเบียบและดูแลรักษาเอกสารภายในโครงการข้อมูลจำเพาะข้อกำหนด ฯลฯ ขณะนี้เราจัดเก็บเอกสารทั้งหมดเป็นไฟล์ MS Word DOC จำนวนมากในแหล่งเก็บข้อมูลการควบคุมแหล่งที่มาซึ่งทำให้เราสามารถควบคุมเวอร์ชันได้ แต่คุณไม่สามารถค้นหาข้อมูลนี้สร้างลิงค์ระหว่างพวกเขาจัดหมวดหมู่ทำงานร่วมกัน

ข้อกำหนดการตั้งค่า:

• การติดตั้งเป็นศูนย์บนฝั่งไคลเอ็นต์ (อิงจากเว็บ)
• การควบคุมเวอร์ชันของเอกสาร
• คำอธิบายประกอบเอกสาร
• การเชื่อมโยงเอกสาร
• การค้นหาแบบเต็ม (เอกสารทั้งหมด)
• MS Word (* .doc) import \ export
• โปรแกรมแก้ไขข้อความ WYSIWYG

ระบบที่ฉันค้นพบและทดลองใช้:

• มีเดียวิกิ
• XWiki
• ที่บรรจบกัน

แล้วสฟิงซ์ล่ะ?

คุณเขียนเอกสารของคุณใน reStructuredText (ไวยากรณ์คล้ายกับ Markdown ซึ่ง Stack Overflow ใช้) ลงในไฟล์ข้อความธรรมดา (= ง่ายต่อการควบคุมเวอร์ชัน) และสฟิงซ์แยกหน้า HTML ออก

ผู้ใช้สฟิงซ์ที่โดดเด่นที่สุดสองคน (ที่ฉันรู้จัก) คือภาษา PythonและTortoiseHG (ดูลิงก์สำหรับเอกสารประกอบสฟิงซ์ที่สร้างขึ้น)

แก้ไข:

ฉันเพิ่งอ่านว่าคุณกำลังพูดถึงเอกสารภายในโครงการไม่ใช่เอกสารสำหรับผู้ใช้
ในความคิดของฉันบางอย่างเช่นสฟิงซ์เป็นวิธีที่ดีที่สุดสำหรับเอกสารภายใน (โดยที่คุณสามารถให้นักวิเคราะห์เขียน reStructuredText) เพราะ:

1. คุณสามารถควบคุมเวอร์ชันเอกสารได้อย่างง่ายดาย (และส่วนต่างของไฟล์ข้อความต้องใช้พื้นที่มากน้อยกว่าไฟล์ไบนารีเช่น. doc หรือ. pdf)
2. หากนักพัฒนาต้องการไฟล์. doc หรือ. pdf ที่สามารถอ่านได้ดีเขาสามารถสร้างมันด้วยสฟิงซ์จากแหล่งที่มา

หากสฟิงซ์ซับซ้อนเกินไปก็มีวิธีที่ง่ายกว่า: คุณสามารถเขียนเอกสารของคุณใน Markdown และใช้Pandocเพื่อสร้าง (ตัวอย่าง) ไฟล์. rtf, .doc หรือ. pdf (สามารถทำได้มากขึ้น)
ฉันพบว่า Pandoc เริ่มต้นได้ง่ายกว่าสฟิงซ์ แต่ Pandoc ไม่สามารถสร้างลำดับชั้นเมนูที่ดีอย่างสฟิงซ์ได้ (เช่นใน Python และ TortoiseHG เอกสารที่ฉันลิงค์ด้านบน)

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

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

แต่: คุณเขียนว่าคุณมี "นักวิเคราะห์" ที่ไม่ใช่นักพัฒนา (ฉันยอมรับว่าฉันไม่ใช่แฟนของกลุ่มดาวนั้น) คนประเภทนี้มักจะไม่พอใจเมื่อคุณเปลี่ยนเครื่องมือ MS Office ด้วยเครื่องมือเชิงข้อความเช่น Wiki และเนื่องจาก MS-Word ไม่ใช่ซอฟต์แวร์ฟรีดังนั้นฉันเดาว่าความต้องการ "ซอฟต์แวร์เสรี" นั้นไม่ใช่สิ่งที่จำเป็นจริงๆ ในสถานการณ์นี้เซิร์ฟเวอร์ Sharepoint อาจเป็นทางเลือกที่ดีกว่า ไม่ฟรี แต่ AFAIK มีคุณสมบัติทั้งหมดที่คุณต้องการและยังสามารถสร้างเอกสารโดยใช้ Word, Excel และอื่น ๆ

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

1. Trac - ระบบติดตามบั๊กและเอ็นจิ้นความรู้ใช้งานง่าย เขียนด้วย Python และสามารถขยายได้คุณจะสามารถใช้งานได้ในไม่กี่นาที
2. MoinMoin - เอ็นจิ้นวิกิเต็มรูปแบบ Python อีกครั้งพร้อมฟีเจอร์มากมาย

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

เราเพิ่งเริ่มใช้Alfresco DMS ซึ่งมีคุณสมบัติที่น่าสนใจมากมาย:

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

นอกจากนี้ยังมีข้อเสีย:

• ส่วนต่อประสานผู้ใช้อาจไม่ง่าย
• มันไม่ใช่วิกิจริง ๆ ดังนั้นการทำงานร่วมกันพร้อมกันในเอกสารเดียวอาจมีความเปราะบาง

หากคุณตัดสินใจที่จะแกว่งมันโปรดติดต่อฉันกับความคิดเห็นของคุณ

ความเป็นไปได้อีกอย่างหนึ่งคือการใช้LaTeXหรือฟอร์แมตข้อความอื่น ๆ (อาจเป็น texinfo หรือแม้แต่lout ) สำหรับเอกสารประกอบ บางส่วนของมันสามารถสร้างเครื่อง มีเครื่องมือบางอย่างสำหรับการแปลง HTML เช่นHeVeAเพื่อแปลง LaTeX เป็น HTML คุณยังสามารถใช้doxygenเพื่อสร้างเอกสารจากความคิดเห็นที่มีโครงสร้างภายในซอร์สโค้ดของคุณ และชิ้นส่วนที่เขียนด้วยมือของเอกสารสามารถ (และควร) ได้รับการจัดการเป็นซอร์สโค้ด (เช่นการควบคุมเวอร์ชันและสร้างเวอร์ชัน)

ฉันขอแนะนำให้ใช้เครื่องมือ UML และ ERD นอกเหนือจากเอกสารของคุณ นอกจากนี้คุณสามารถจัดเก็บเอกสารเหล่านี้ใน ZOHO ได้ที่ZOHO-Docsซึ่งไม่ฟรี แต่ราคาถูกมากและอนุญาตการค้นหาเอกสาร

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