Phần mềm tổ chức và duy trì tài liệu dự án, đặc điểm kỹ thuật? [đóng cửa]

Tôi đang tìm kiếm phần mềm để tổ chức và duy trì tài liệu nội bộ, thông số kỹ thuật, yêu cầu, v.v. Hiện tại chúng tôi lưu trữ tất cả tài liệu dưới dạng nhiều tệp MS Word DOC trong kho lưu trữ kiểm soát nguồn, cho phép chúng tôi kiểm soát phiên bản và điều đó thật tuyệt. Nhưng bạn không thể tìm kiếm thông tin này, tạo liên kết giữa chúng, phân loại, cộng tác.

Yêu cầu, sở thích:

• Không cài đặt ở phía máy khách (dựa trên WEB).
• Kiểm soát phiên bản tài liệu.
• Chú thích tài liệu.
• Liên kết tài liệu.
• Tìm kiếm đầy đủ (tất cả tài liệu).
• MS Word (* .doc) nhập \ xuất.
• Trình soạn thảo văn bản WYSIWYG.

Các hệ thống tôi đã phát hiện và thử cho đến nay:

• MediaWiki
• XWiki
• Hợp lưu

Làm thế nào về một cái gì đó như Sphinx ?

Bạn viết tài liệu của mình trong reSturationuredText (cú pháp tương tự như Markdown, mà Stack Overflow sử dụng) vào các tệp văn bản đơn giản (= dễ kiểm soát phiên bản) và Sphinx phun ra các trang HTML.

Hai người dùng Sphinx nổi bật nhất (mà tôi biết) là ngôn ngữ Python và TortoiseHG (xem các liên kết cho tài liệu Sphinx được tạo).

BIÊN TẬP:

Tôi chỉ đọc rằng bạn đang nói về tài liệu nội bộ dự án, không phải tài liệu người dùng cuối.
Theo tôi, một cái gì đó như Sphinx cũng là cách tốt nhất cho tài liệu nội bộ (với điều kiện bạn có thể khiến các nhà phân tích của mình viết reSturationuredText) bởi vì:

1. Bạn có thể dễ dàng kiểm soát phiên bản tài liệu (và khác biệt của tệp văn bản chiếm nhiều dung lượng, ít hơn nhiều so với tệp nhị phân như .doc hoặc .pdf).
2. Nếu một nhà phát triển muốn có một tệp .doc hoặc .pdf dễ đọc, anh ta có thể tạo nó bằng Sphinx từ các nguồn.

Nếu Sphinx quá phức tạp, thậm chí còn có một cách dễ dàng hơn: bạn có thể viết tài liệu của mình trong Markdown và sử dụng Pandoc để tạo (ví dụ) các tệp .rtf, .doc hoặc .pdf (nó có thể làm được nhiều hơn thế).
Tôi thấy Pandoc dễ dàng bắt đầu hơn Sphinx, nhưng Pandoc không thể tạo ra hệ thống phân cấp menu đẹp như Sphinx (như trong tài liệu Python và TortoiseHG tôi đã liên kết ở trên).

Bất kể bạn sử dụng công cụ nào, nếu bạn có máy chủ web nội bộ và máy chủ xây dựng, bạn có thể thiết lập nó để máy chủ xây dựng tạo đầu ra HTML và sao chép nó trên máy chủ web mỗi khi ai đó đẩy thứ gì đó vào tài liệu. Vì vậy, các nhà phân tích của bạn thậm chí không phải suy nghĩ về đầu ra cuối cùng, họ chỉ cần cam kết và thúc đẩy các thay đổi của họ.

Chà, bạn có thể thử triển khai Wiki. Mediawiki có tất cả các tính năng còn thiếu mà bạn đang nói đến (chức năng tìm kiếm, lịch sử phiên bản, liên kết, phân loại). Bạn sẽ phải đảm bảo rằng bạn biết chính xác phiên bản tài liệu thuộc về phiên bản phần mềm nào, nhưng điều đó có thể được thực hiện theo quy ước bao gồm tham chiếu phiên bản hoặc danh mục cụ thể trong mỗi bài viết phụ thuộc phiên bản.

NHƯNG: Bạn viết rằng bạn có "nhà phân tích" không phải là nhà phát triển (tôi thừa nhận, tôi không phải là người hâm mộ của chòm sao đó). Những người như vậy thường không hài lòng khi bạn thay thế các công cụ MS Office của họ bằng một số công cụ định hướng văn bản như Wiki. Và vì MS-Word không phải là phần mềm miễn phí, nên tôi đoán yêu cầu "phần mềm miễn phí" không thực sự bắt buộc. Trong tình huống này, một máy chủ Sharepoint có thể là sự thay thế tốt hơn. Không miễn phí, nhưng AFAIK nó có tất cả các tính năng bạn đang yêu cầu và tài liệu vẫn có thể được tạo bằng Word, Excel, v.v.

Luôn luôn tốt hơn để giữ đặc tả và tài liệu dưới sự kiểm soát phiên bản vì nó sẽ mang lại cho bạn đòn bẩy lớn nhất mặc dù đường cong học tập sẽ hơi dốc. Trong trường hợp của một công cụ kiến ​​thức, tôi khuyên bạn nên như sau

1. Trac - Dễ dàng sử dụng hệ thống theo dõi lỗi và công cụ kiến ​​thức. Được viết bằng Python và có thể mở rộng, bạn sẽ khởi động và chạy trong vài phút
2. MoinMoin - Công cụ wiki chính thức. Một lần nữa Python với rất nhiều tính năng

Cả hai đều có giao diện tối thiểu, hỗ trợ hầu hết các cấu trúc wiki, khá dễ triển khai và bảo trì, hỗ trợ sửa đổi, có trình soạn thảo WYSIWYG tốt và thậm chí bạn có thể giữ tài liệu và thông số kỹ thuật của mình. Trừ khi các dự án của bạn thực sự rất lớn, bạn có thể chọn bất kỳ điều nào ở trên.

Gần đây chúng tôi đã bắt đầu sử dụng Alfresco DMS có nhiều đặc tính thú vị:

• Cài đặt rất đơn giản
• Có một bộ chỉ mục tích hợp để tìm kiếm nhanh qua hàng đống tài liệu
• Cho phép luồng công việc, nhóm và nếu cần, khách hàng truy cập cụ thể vào tài liệu
• Mã nguồn mở
• Cộng đồng năng động
• Tích hợp LDAP / AD / SSO
• Xử lý nhiều tài liệu khác nhau

Cũng có một số nhược điểm:

• Giao diện người dùng không phải lúc nào cũng trực quan
• Nó không thực sự là một wiki, vì vậy công việc cộng tác đồng thời trên một tài liệu có thể hơi mong manh

Nếu bạn quyết định cho nó một cú swing, xin vui lòng liên hệ với tôi với ý kiến ​​của bạn.

Một khả năng khác có thể là sử dụng LaTeX hoặc một số công cụ định dạng văn bản khác (có thể là texinfo hoặc thậm chí là lout ) cho tài liệu. Các bộ phận của nó có thể được tạo ra máy. Có một số công cụ để chuyển đổi HTML, như HeVeA để chuyển đổi LaTeX sang HTML. Bạn cũng có thể sử dụng doxygen để tạo tài liệu từ các nhận xét có cấu trúc bên trong mã nguồn của mình. Và các phần viết tay của tài liệu có thể (và nên) được quản lý dưới dạng mã nguồn (ví dụ: kiểm soát và xây dựng phiên bản).

Tôi sẽ đề nghị sử dụng công cụ UML và ERD, ngoài các tài liệu của bạn. Ngoài ra, bạn có thể lưu trữ các tài liệu này trên ZOHO tại ZOHO-Docs , không miễn phí, nhưng nó cực kỳ rẻ và cho phép các phương tiện tìm kiếm tài liệu.

Dù bạn sử dụng công cụ nào, bạn cần tổ chức nội dung tài liệu một cách cẩn thận để có thể sử dụng tìm kiếm văn bản và nhận được kết quả có ý nghĩa. Tổ chức nội dung tài liệu cùng với việc đặt tên tệp thông minh và chuẩn có thể giúp ích rất nhiều.