mục tiêu là có một hệ thống tài liệu trực tuyến, với những yêu cầu chính sau:
- sẽ chủ yếu được sử dụng như một giai đoạn trung gian cho các tài liệu kỹ thuật cuối cùng của tất cả các ứng dụng của chúng tôi (có lẽ sẽ không bao giờ được hoàn thành mặc dù:]). Nó thường được sử dụng như vậy: ai đó có vấn đề, tôi sửa nó và viết ra bản sửa lỗi ngay lập tức. Điều xảy ra bây giờ đang trở nên khó kiểm soát: ai đó có vấn đề, tôi sửa nó, cả tôi và ai đó đều hạnh phúc nhưng 2 tháng sau lại có người khác gặp vấn đề tương tự và không ai nhớ cách khắc phục.
- có thể truy cập từ mọi nơi, chạy phía sau máy chủ apache của chúng tôi
- quản lý người dùng / nhóm, cho phép truy cập chỉ đọc / đọc / ghi / quản trị viên
- định dạng không quá quan trọng: văn bản đơn giản sẽ làm được, kiểu wiki sẽ đẹp hơn
- rẻ hay miễn phí
một số ý tưởng của tôi:
- chỉ phục vụ các tệp trên chia sẻ tệp hoặc thông qua ssh (nhược điểm: không quá tương thích với windows, ưu: đơn giản, có thể là bất kỳ loại tệp nào)
- giữ nó trong một SCM (svn / git, idem như trên nhưng dễ dàng truy cập và kiểm soát truy cập hơn)
- Confluence: chúng ta đã sử dụng Jira rồi, Confluence có đáng không? Làm thế nào để nó tích hợp với Jira?
- thứ gì khác?
Xin đừng ngần ngại bình luận về những điều này hoặc chia sẻ kinh nghiệm của bạn với các hệ thống khác.
Là tài liệu được tạo từ mã (chẳng hạn như Javadocs) hoặc nó được viết từ đầu, dưới dạng hướng dẫn sử dụng hoặc kết hợp cả hai?
—
Thất vọngWithFormsDesigner
nó chủ yếu là chi tiết của một hướng dẫn sử dụng, chứ không phải tài liệu mã (tốt, chúng tôi có đó là tốt, được tạo ra bởi doxygen, chúng tôi có thể bao gồm nó, nhưng nó không phải là điểm đầu tiên của lãi)
—
Stijn
Tôi sẽ giao một số tiền mặt cho Spolsky.
—
Công việc