9.1.5 Tài liệu lưu trữ
Tạo một khu vực lưu trữ tài liệu, hoặc kho lưu trữ tài liệu, là một bước quan trọng trong quá trình tài liệu. Một vị trí tập trung cung cấp
một điểm khởi đầu cho việc tổ chức và cập nhật các tài liệu. Thông thường, mỗi
SA có bản sao cá nhân của nguồn tài liệu và ghi chú cá nhân; có một
kho lưu trữ trung ương làm cho nó dễ dàng hơn cho người dân để tìm phiên bản mới nhất
của tài liệu.
Tạo ra một kho lưu trữ tài liệu cũng là một cách tuyệt vời để tìm hiểu về các
tài liệu mà bạn đã không nhận ra bạn đã có. Nếu có một kho lưu trữ trung ương,
người sẽ mang lại những mảnh lẻ của tài liệu mà họ đã viết. Hầu hết các
SAs có một hoặc nhiều thư mục đầy đủ các văn bản nhắc nhở và sẽ sẵn sàng
chia sẻ chúng khi có một nơi để đặt chúng.
248 Chương 9 Tài liệu
Phương pháp đơn giản nhất để làm một kho lưu trữ tài liệu là để tạo ra một
thư mục tài liệu trên một khối lượng chia sẻ. Bắt đầu nó đi với một README
tập tin mô tả bất kỳ quy định hoặc chính sách cần được theo sau trong việc đưa ra
các tài liệu để đưa vào kho lưu trữ này. Bạn có thể muốn thêm các
mẫu từ mục 9.1.2. Tạo một thư mục con khởi đặt tên theo
các loại chủ đề bạn muốn có, chẳng hạn như máy tính để bàn hoặc máy in hoặc Linux.
Khi nhân viên SA tạo ra các tài liệu, thêm chúng vào các thư mục con phù hợp, tạo ra một, nếu cần thiết, và sử dụng tên tập tin mô tả tài liệu .
Một người nào đó tìm kiếm một cái gì đó đặc biệt chỉ có thể liệt kê nội dung thư mục con và tìm kiếm cho các hạng mục quan tâm. Ví dụ, một người nào đó tìm kiếm
cho một tài liệu về làm thế nào để thêm máy in có thể danh sách các máy in thư mục con
hoặc liệt kê tất cả các thư mục con và lọc trên bất kỳ tên tập tin bao gồm các
bản in từ.
Thêm điều khiển mã nguồn đến một kho lưu trữ tài liệu có thể hữu ích trong
việc khôi phục các phiên bản trước đó của một tài liệu, nếu ai đó làm cho những thay đổi mà biến
ra là không chính xác, hoặc nếu một tập tin vô tình bị xóa. Nó là ít nhưng nhiều
rắc rối để kiểm tra một phiên bản trùng lặp từ một kho lưu trữ mã nguồn hơn để
làm một khôi phục lại từ bản sao lưu phương tiện truyền thông. Sản phẩm mã nguồn mở, chẳng hạn như Subversion,
làm cho nó dễ dàng để thiết lập một kho đơn giản.
Một trang web có thể là một kho lưu trữ tài liệu xuất sắc, nhưng thủ duy trì các bảng nội dung và như vậy có thể được nhiều việc hơn bạn đang tiết kiệm bằng cách
có các tài liệu ở nơi đầu tiên. Một giải pháp là để cấu hình web
server để xem nội dung của thư mục. Thư mục mặc định nhiều máy chủ web
'danh sách mã chỉ hỗ trợ tên tập tin của một độ dài nhất định, mô tả quá lâu
tên này có thể trở nên bị cắt bớt. Các máy chủ web khác làm cho nó dễ dàng để kiểm soát
chiều rộng tên tập tin được hiển thị trong một chỉ mục.
Thiết lập một thư mục Shared
Khi Tom làm việc cho Mentor Graphics, nhóm của ông đã duy trì một thư mục trên một máy chủ trung tâm, / home / adm / docs, chứa thức . Hướng dẫn về các chủ đề khác nhau
Tên tập tin dài và mô tả: làm thế nào để tạo ra-accounts.txt hoặc lý do-whyprinter-P32-fails.txt. Tìm kiếm đã được thực hiện với các công cụ dòng lệnh UNIX, chẳng hạn như
ls và grep. Trong một nỗ lực rất thô sơ để duy trì độ chính xác, tất cả mọi người luôn luôn kiểm tra
ngày của tập tin như là một phần của đánh giá xem các thông tin đã lỗi thời. Hôm nay,
một hệ thống kiểm soát phiên bản sẽ được sử dụng để thay thế.
Mặc dù không phức tạp, hệ thống này phục vụ mục đích của nó tốt. Thật dễ dàng để tạo ra một
tài liệu mới, dễ dàng để chỉnh sửa một cũ, và dễ dàng để tìm thấy những thông tin cần thiết.
9.1 Khái niệm cơ bản 249
Systems 9.1.6 Wiki
Wiki là một công cụ xuất bản và cộng tác dựa trên web mà đã cách mạng hóa kho tài liệu. Tên có nguồn gốc từ Wikiwiki, Hawaiian thông tục cho nhanh chóng. Các wiki đầu tiên là phần mềm được gọi WikiWikiWeb,
mà sanh wiki generic hạn.
Một wiki là một kho lưu trữ tài liệu dựa trên web mà làm cho nó dễ dàng cho
bất cứ ai có quyền truy cập thích hợp để thêm và chỉnh sửa tài liệu. Tài liệu có thể
chứa plaintext, văn bản với Hypertext Markup Language (HTML), hoặc văn bản
với các thẻ định dạng nhúng wiki cụ thể hoặc lệnh. Thông thường, các wiki
đã được xây dựng trong hệ thống kiểm soát nguồn mã để kiểm tra các tập tin tài liệu trong và ngoài
và giữ lại lịch sử sửa đổi. Môi trường wiki nâng cao hơn bao gồm người sử dụng
xác thực, gắn thẻ tự động cập nhật (ngày, giờ, người dùng), mỗi người dùng khóa các tập tin, kiểm soát truy cập của người dùng hoặc nhóm, và mức độ khác nhau của granularity
đọc / sửa đổi / xuất bản trên các thư mục tài liệu cá nhân hoặc các thư mục con .
Các khía cạnh mạnh mẽ nhất của wiki là bất cứ ai có thể cập nhật bất kỳ trang nào. Nếu
có điều gì đó sai hoặc lỗi thời, người treo nó báo lỗi có thể sửa chữa
nó hoặc thêm một lưu ý yêu cầu một ai đó để xác minh và sửa chữa các thông tin. Tài liệu kỳ diệu phát triển và ở hiện tại. Người ta có thể tự hỏi những gì ngăn cản
một người nào đó chỉ đơn giản là xóa các văn bản ngẫu nhiên và thêm thông tin sai;
tất cả thay đổi được theo dõi bởi người sử dụng; Do đó, một người nào đó làm nghịch ngợm sẽ được
xác định. Trong một môi trường doanh nghiệp, áp lực xã hội sẽ tiếp tục các sự kiện như vậy
rất hiếm. Nếu họ làm ra, các trang có thể được chuyển đến một trạng thái trước đó, bằng cách sử dụng đầy đủ
lịch sử sửa đổi. Nó có thể bảo vệ các trang để chỉ những người nào đó
có thể thay đổi chúng, một biện pháp phòng ngừa tốt cho các tài liệu nhạy cảm cao.
Các wiki lệnh định dạng rất dễ học và dễ dàng hơn nhiều
cho những người không biết kỹ thuật sử dụng hơn là HTML. Nhiều công ước email mà họ
đã sử dụng được hỗ trợ, chẳng hạn như * văn bản này sẽ xuất hiện đậm * và
văn bản này nhấn mạnh. URL sẽ được tự động chuyển thành liên kết siêu văn bản.
Viết tên của một trang wiki được phát hiện và chuyển thành liên kết.
Trang Wiki thường được đặt tên trong CamelCase-còn gọi là WikiWords hoặc
StudlyCaps-để phần mềm có thể phát hiện chúng dễ dàng. Sử dụng một WikiWord
mà không liên quan đến một trang wiki tạo ra một liên kết đó sẽ nhắc nhở người dùng
để tạo ra các trang.
Khả năng để tạo ra các trang giữ chỗ cho những thứ như bạn nhận ra rằng
bạn sẽ cần đến chúng là cực kỳ hữu ích. Nó rất hữu ích cho đến khi bạn đã
trải qua nó, bạn không thể nghĩ rằng đó là một vấn đề lớn. Bạn có thể tạo ra một chỉ số
hoặc bảng nội dung cho một kho lưu trữ tài liệu và điền vào các tài liệu khi chúng
được tạo ra.
250 Chương 9 Tài liệu
Cùng với nhau, các tính năng này tạo ra một công cụ cộng tác lý tưởng. Nó có thể rất
hài lòng để xem cách nhanh chóng các tài liệu hình thành và kho lưu trữ bắt đầu
để nhìn thực tế và hữu ích. Điều này khuyến khích người khác đóng góp và giữ
đà tăng.
Sử dụng một Wiki
Các dễ dàng mà tài liệu của các hình thức khác nhau có thể được tạo ra với một wiki được
thực hiện đặc biệt rõ ràng với Strata khi làm việc tại một doanh nghiệp nhỏ mới thành lập trong một nhà máy cũ
xây dựng ở Seattle . Một số nhân viên, bao gồm cả Strata, đã từ ngoài thành phố và
có xu hướng đi du lịch thường xuyên, dùng bữa trong văn phòng và giữ lịch trình ngẫu nhiên.
Nếu không có bất cứ yêu cầu cụ thể, chỉ thị, các bit thông tin hữu ích bắt đầu thể hiện
lên trên trang wiki intranet, nhiều như thông tin thường xuyên xuất hiện trên bảng trắng trong một
văn phòng chia sẻ. Sự khác biệt là các nhân viên out-of-thị trấn có thể tham gia như là
một cách dễ dàng như những người trong văn phòng, và các thông tin dao động từ thông tin liên lạc cho các nhỏ
công ty chia sẻ kết nối mạng để lịch trình du lịch của người dân để tư vấn cách tự cứu
trên cũ ọp ẹp dịch vụ thang máy mà đôi khi đã bị mắc kẹt giữa các tầng. Có
thậm chí là một trang công thức cho nồi cơm văn phòng. Các trang web wiki là một minh chứng thanh lịch để
sức mạnh của công nghệ để hỗ trợ các hệ thống tự tổ chức thay vì nhận được trong cách.
❖ Giúp Chọn một Wiki WikiMatrix (www.wikimatrix.org) cung cấp
các công cụ để giúp so sánh và lựa chọn gói thích hợp cho một định
tình hình.
9.1.7 Một tìm kiếm Cơ sở
A công cụ tìm kiếm là phải cho một hệ thống tài liệu sống. Mọi người đang đi
để đưa công cụ mà nó không thể dễ dàng tìm được những người khác. May mắn thay, nhiều công cụ công cụ tìm kiếm DROPIN thể được sử dụng với một kho lưu trữ web. Những công cụ này nằm trong khoảng
từ gói mã nguồn mở cho các thiết bị phần cứng được thiết kế để chỉ mục
dữ liệu trong toàn bộ doanh nghiệp. Khi lựa chọn một công cụ tìm kiếm, xem xét
mức độ granularity tìm kiếm và tùy chọn tìm kiếm có sẵn, cũng như những loại
tài liệu có thể được truy cập cho toàn nội dung chỉ mục.
Đây là một lợi thế để có thể giới hạn tìm kiếm những vùng cụ thể hoặc đối tượng.
Một có thể xác định chỉ để tìm kiếm các tên các tài liệu hoặc các văn bản trên
các trang nơi họ được liên kết. Các tìm kiếm khác có thể bao gồm các nội dung của các
tài liệu bản thân hoặc các từ khóa hoặc thẻ liên kết với các trang.
Không phải tất cả các công cụ tìm kiếm hỗ trợ các truy vấn phức tạp, chẳng hạn như yêu cầu
rằng lời nói cụ thể có mặt hoặc vắng mặt, hoặc cho phép một truy vấn siêu dữ liệu về
9.1 Khái niệm cơ bản 251
tài liệu. Một ví dụ về sau có thể được yêu cầu để tìm các tài liệu
bao gồm các giấy phép phần mềm và cụm từ được tạo ra trước 1 tháng Giêng
9.1.8 Rollout vấn đề
Một khía cạnh rất quan trọng để cung cấp một kho lưu trữ tài liệu mới được nhận buy-in
từ các cộng đồng đó sẽ được sử dụng nó. Người sử dụng cũng là tác giả, và
nếu một tỷ lệ phần trăm cao của folks đào ở gót chân của họ, hiệu quả của toàn bộ dự án
sẽ trở thành vấn đề. Trớ trêu thay, đó là rất nhiều các chuyên gia kỹ thuật cũ-bảo vệ người
các kháng nhất. Họ đã sống trong một thế giới email trung tâm cho các lứa tuổi và không
cảm thấy rằng cần phải đi ra ngoài trên web để tham gia là tôn trọng thời gian của họ.
Chắc chắn có một đối số phải được thực hiện để có một hộp thư đến của công cụ mới
để theo dõi! Một cách để giải quyết vấn đề này là để đảm bảo rằng một gần
khu vực thay đổi được tự động tạo ra như một phần của wiki. Một số hệ thống
cho phép trang này để được định kỳ gửi qua email cho một danh sách những người có liên quan, hoặc nó
có thể được cấu hình để cung cấp các thông tin như một nguồn cấp dữ RSS1 để nó có thể được
đọc như một blog. Cung cấp nhiều cách để truy cập các thông tin tương tự làm cho
nó dễ dàng hơn cho người dân để thông qua.
Thông qua tài liệu tốt hơn thực hành về
Sức mạnh của wiki là có rất ít trở ngại để bắt đầu mà mọi người đang
rút ra trong việc sử dụng nó. Tại một trang web, Tom đã không nhận mua-in cho một hệ thống dựa trên wiki nào,
do đó, ông đã lắp đặt một trên một server và bắt đầu sử dụng nó để lưu trữ tài liệu riêng của mình. Ngay sau đó,
khi người ta hỏi anh ở đâu để tìm certai
đang được dịch, vui lòng đợi..
