Công cụ giống như Wiki để viết thông số kỹ thuật và tài liệu [đóng]


9

Tôi đang tìm kiếm một hệ thống giống như wiki hoặc wiki để viết và quản lý đặc tả và tài liệu cho một dự án phần mềm.

Tôi biết có rất nhiều triển khai wiki có sẵn, nhưng có một số đặc biệt phù hợp với loại nhiệm vụ này không?

Trên thực tế, nó không phải là một wiki, chỉ là một hệ thống giúp bạn dễ dàng viết và điều hướng các thông số kỹ thuật và tài liệu, và hỗ trợ theo dõi thay đổi.


1
Bạn đang sử dụng một nền tảng đặc biệt? Giống như TFS của Microsoft chẳng hạn?
Saeed Neamati

Cùng với những gì @Saeed đã hỏi, nhóm / tổ chức của bạn đã có sẵn cơ sở hạ tầng nào để quản lý và chia sẻ kiến ​​thức? Ngoài ra, các quy trình hiện tại của bạn để viết thông số kỹ thuật và tài liệu là gì?
Thomas Owens

Câu trả lời:


6

Chúng tôi đang sử dụng LaTeX và SVN. Vì các tài liệu LaTeX chỉ là các tệp văn bản, nên nó chơi tốt với kiểm soát phiên bản, không giống như một số định dạng nhị phân hoặc một phần nhị phân.

Bạn nhận được tất cả các ưu điểm (và nhược điểm, thừa nhận) của kiểm soát phiên bản mà bạn đã quen với việc sử dụng nó với mã của mình.

LaTeX có một chút thiết lập (để xác định phong cách / lớp của riêng bạn), nhưng một khi bạn đã làm rất tốt - bạn chỉ có thể tập trung vào nội dung thay vì trình bày của nó (thay vì bị cám dỗ liên tục chỉnh sửa như bạn WYSIWYG), nhưng vẫn nhận được một tài liệu PDF bóng bẩy, chuyên nghiệp ở cuối.


4

Cá nhân, tôi thực sự thích Tiddly Wiki .

Nó có một cú pháp wiki khá hoàn chỉnh, là một tệp html đơn chứa và hoạt động tốt với nhiều trình duyệt web khác nhau mà không cần máy chủ.

Nó thậm chí còn có một kiến ​​trúc plugin mở rộng cho phép bạn thêm các plugin để thực hiện tất cả các loại điều thú vị như mã hóa trình điều khiển hoặc thêm chú thích.


3

Đối với nền tảng Microsoft, tích hợp TFS (Team Foundation Server) với SharePoint chính là thứ bạn đang tìm kiếm. Bằng cách tạo một dự án nhóm mới, bạn có thể chọn một mẫu bao gồm hầu hết mọi khía cạnh của quy trình phát triển phần mềm. Nó cung cấp cho bạn một cổng thông tin trong đó bạn có thể xác định các thành viên trong nhóm, gán vai trò và quyền bảo mật của họ, tải lên, chia sẻ và chỉnh sửa các tài liệu và thông số kỹ thuật liên quan đến dự án của bạn và thực hiện nhiều điều thú vị khác với nó.

Đối với các nền tảng khác, tôi nghĩ bạn có thể sử dụng một cái gì đó như GitHub (mặc dù, tôi không chắc về nó).


0

Đối với dự án cá nhân (chỉ tồn tại trong PC của tôi) tôi sử dụng Wiki trong Jar . Trước đây tôi đã làm việc với Redmine (nó còn có thêm một hệ thống theo dõi lỗi và SCM)


0

Bạn có thể thử Sphinx , với các tài liệu được kiểm tra trong cơ sở hạ tầng quản lý kiểm soát nguồn của bạn. Điều này có các ưu điểm của kiểm soát nguồn và ngôn ngữ đánh dấu tương đối nhẹ, reSturationuredText , dễ học và là công cụ khá tốt để chuyển đổi (sang HTML, sang PDF, v.v.).

Khi sử dụng trang web của chúng tôi, bạn xác nhận rằng bạn đã đọc và hiểu Chính sách cookieChính sách bảo mật của chúng tôi.
Licensed under cc by-sa 3.0 with attribution required.