9.1.4 The Power of ChecklistsA good

9.1.4 The Power of Checklists
A good way to start creating documentation and to function more efficiently
in general is to use checklists, or lists of things arranged so that each line
or paragraph contains only one step. As each item is completed, it can be
checked off by making a mark next to it.
Checklists let you complete complex tasks and then verify that you have
completed the steps. It’s very obvious that you skipped a step if you are
9.1 The Basics 247
marking them off as each one is completed. A checklist can be used by someone less experienced to ensure that every aspect of the process has been finished. Requiring junior staff to file completed checklists or simply to hand
them to their manager is a good way to create accountability. For really important processes, especially those that may involve the cooperation of several people or departments to accomplish, a signed checklist can be a good
way to document that all the steps have been performed by the appropriate parties. Many SAs use checklists in their own daily task management to
keep track of all the steps in complex tasks and all the tasks that need to
be done.
Some typical checklists include
• Tasks to be done for each new hire
• Tasks to be done for each employee termination
• Installation tasks for each operating system used at a location
• Process for archiving and for off-site storage of data as required by the
legal department
• Process for securing the OS before deploying a machine
Add checklists to regular documentation, especially for tasks that are
performed frequently. After having used the full document many times, the
person will need only the checklist.
Automating entire processes can be difficult; automating the most errorprone steps from a checklist can be more manageable. If this process is repeated enough, the entire sequence will be eventually automated.
9.1.5 Documentation Storage
Creating a storage area for documents, or document repository, is an important step in the documentation process. A centralized location provides
a starting point for organizing and updating the documents. Typically, each
SA has personal source copies of documents and personal notes; having a
central repository makes it easier for people to find the most recent version
of a document.
Creating a document repository is also a great way to find out about
documentation you didn’t realize you had. If there is a central repository,
people will bring odd pieces of documentation that they have written. Most
SAs have one or more directories full of reminder documents and will gladly
share them when there is a place to put them.
248 Chapter 9 Documentation
The simplest method for making a document repository is to create a
documentation directory on a shared volume. Start it off with a README
file that describes any rules or policies that should be followed in making
the documentation for inclusion in this repository. You might want to add the
template from Section 9.1.2. Create some starter subdirectories named after
the kinds of topics you want to have, such as desktops or printers or Linux.
As the SA staff creates documents, add them to the appropriate subdirectory, creating one, if necessary, and use filenames that describe the document.
Someone looking for something in particular can simply list the subdirectory contents and search for items of interest. For example, someone looking
for a document on how to add printers could list the printers subdirectory
or list all the subdirectories and filter on any filenames that include the
word print.
Adding source code control to a document repository can be useful in
recovering earlier versions of a document if someone makes changes that turn
out to be incorrect or if a file is accidentally deleted. It is usually much less
trouble to check out a duplicate version from a source code repository than to
do a restore from backup media. Open source products, such as SubVersion,
make it easy to set up a simple repository.
A web site can be an excellent document repository, but manually maintaining tables of contents and so on can be more work than you’re saving by
having the documents in the first place. One solution is to configure the web
server to list the contents of directories. Many web servers’ default directory
listing code supports only filenames of a certain length, so long descriptive
names may become truncated. Other web servers make it easy to control the
filename width that is displayed in an index.

Kết quả (Việt) 1:

9.1.4 The Power of ChecklistsA good way to start creating documentation and to function more efficientlyin general is to use checklists, or lists of things arranged so that each lineor paragraph contains only one step. As each item is completed, it can bechecked off by making a mark next to it.Checklists let you complete complex tasks and then verify that you havecompleted the steps. It’s very obvious that you skipped a step if you are9.1 The Basics 247marking them off as each one is completed. A checklist can be used by someone less experienced to ensure that every aspect of the process has been finished. Requiring junior staff to file completed checklists or simply to handthem to their manager is a good way to create accountability. For really important processes, especially those that may involve the cooperation of several people or departments to accomplish, a signed checklist can be a goodway to document that all the steps have been performed by the appropriate parties. Many SAs use checklists in their own daily task management tokeep track of all the steps in complex tasks and all the tasks that need tobe done.Some typical checklists include• Tasks to be done for each new hire• Tasks to be done for each employee termination• Installation tasks for each operating system used at a location• Process for archiving and for off-site storage of data as required by thelegal department• Quá trình để bảo vệ hệ điều hành trước khi triển khai một máyThêm danh sách kiểm tra tài liệu hướng dẫn thường xuyên, đặc biệt là cho các nhiệm vụthực hiện thường xuyên. Sau khi có sử dụng các tài liệu đầy đủ nhiều lần, cácngười sẽ cần chỉ là danh sách kiểm tra.Tự động hoá toàn bộ quá trình có thể được khó khăn; tự động hoá các bước errorprone hầu hết từ một danh sách kiểm tra có thể dễ quản lý hơn. Nếu quá trình này được lặp đi lặp lại đủ, dãy toàn bộ sẽ được tự động cuối cùng.9.1.5 tài liệu lưu trữTạo ra một khu vực lưu trữ cho tài liệu hoặc tài liệu kho, là một bước quan trọng trong quá trình tài liệu. Một điểm tập trung cung cấpmột điểm khởi đầu để tổ chức và cập nhật các tài liệu. Thông thường, mỗiSA có nguồn cá nhân bản sao của tài liệu và các ghi chú cá nhân; có mộtTrung tâm kho làm cho nó dễ dàng hơn cho người dân để tìm phiên bản mới nhấtcủa một 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ềtài liệu bạn đã không nhận ra bạn đã có. Nếu có một kho lưu trữ Trung tâm,người sẽ mang lại cho phần lẻ của tài liệu mà họ đã viết. Hầu hếtSAs có một hoặc nhiều thư mục đầy đủ các lời nhắc nhở tài liệu và sẽ sẵn sàngchia sẻ chúng khi có một nơi để đặt chúng.248 chương 9 tài liệuCác phương pháp đơn giản nhất để làm cho một kho lưu trữ tài liệu là để tạo ra mộttài liệu hướng dẫn các thư mục trên một ổ đĩa được chia sẻ. Bắt đầu với một READMEtập tin mô tả bất kỳ quy tắc hoặc chính sách cần được theo sau trong làmthe documentation for inclusion in this repository. You might want to add thetemplate from Section 9.1.2. Create some starter subdirectories named afterthe kinds of topics you want to have, such as desktops or printers or Linux.As the SA staff creates documents, add them to the appropriate subdirectory, creating one, if necessary, and use filenames that describe the document.Someone looking for something in particular can simply list the subdirectory contents and search for items of interest. For example, someone lookingfor a document on how to add printers could list the printers subdirectoryor list all the subdirectories and filter on any filenames that include theword print.Adding source code control to a document repository can be useful inrecovering earlier versions of a document if someone makes changes that turnout to be incorrect or if a file is accidentally deleted. It is usually much lesstrouble to check out a duplicate version from a source code repository than todo a restore from backup media. Open source products, such as SubVersion,make it easy to set up a simple repository.A web site can be an excellent document repository, but manually maintaining tables of contents and so on can be more work than you’re saving byhaving the documents in the first place. One solution is to configure the webserver to list the contents of directories. Many web servers’ default directorylisting code supports only filenames of a certain length, so long descriptive
names may become truncated. Other web servers make it easy to control the
filename width that is displayed in an index.

Kết quả (Việt) 2:

9.1.4 Sức mạnh của danh mục kiểm tra
Một cách tốt để bắt đầu tạo tài liệu và hoạt động hiệu quả hơn
nói chung là sử dụng bản danh sách, hoặc một danh sách những điều sắp xếp sao cho mỗi dòng
hoặc đoạn chứa chỉ một bước. Như mỗi mục được hoàn thành, nó có thể được
kiểm tra bằng cách tạo ra dấu bên cạnh nó.
Danh sách kiểm tra cho phép bạn hoàn thành các nhiệm vụ phức tạp và sau đó xác nhận rằng bạn đã
hoàn thành các bước. Nó rất rõ ràng rằng bạn bỏ qua một bước, nếu bạn là
9.1 Khái niệm cơ bản 247
đánh dấu chúng như là của mỗi người đều được hoàn thành. Một danh sách kiểm tra có thể được sử dụng bởi người ít kinh nghiệm để đảm bảo rằng tất cả các khía cạnh của quá trình này đã được hoàn thành. Yêu cầu nhân viên cơ sở để nộp danh sách kiểm tra hoàn thành hoặc đơn giản chỉ để trao
chúng cho người quản lý của họ là một cách tốt để tạo ra trách nhiệm. Đối với quá trình thực sự quan trọng, đặc biệt là những người mà có thể liên quan đến sự hợp tác của một số người dân hoặc các phòng ban để thực hiện, một danh sách kiểm tra ký kết có thể là một tốt
cách để ghi nhận rằng tất cả các bước đã được thực hiện bởi các bên liên quan. Nhiều SAs sử dụng danh sách kiểm tra trong quản lý công việc hàng ngày của mình để
theo dõi tất cả các bước trong công việc phức tạp và tất cả các nhiệm vụ cần phải
được thực hiện.
Một số danh sách kiểm tra điển hình bao gồm
Tasks • được thực hiện cho mỗi mới thuê
• Các nhiệm vụ phải thực hiện cho mỗi nhân viên chấm dứt
nhiệm vụ • Cài đặt cho mỗi hệ điều hành được sử dụng tại một địa điểm
• Quy trình để lưu trữ và cho lưu trữ off-site của các dữ liệu theo yêu cầu của các
bộ phận pháp lý
• Quy trình để đảm bảo cho các hệ điều hành trước khi triển khai một máy
Thêm danh sách kiểm tra tài liệu hướng dẫn thường xuyên, đặc biệt là cho các nhiệm vụ được
thực hiện thường xuyên. Sau khi sử dụng tài liệu đầy đủ nhiều lần, những
người sẽ chỉ cần danh sách kiểm tra.
Tự động hoá toàn bộ quy trình có thể khó khăn; tự động hoá các bước errorprone nhất từ một danh sách kiểm tra có thể được quản lý hơn. Nếu quá trình này được lặp lại đủ, toàn bộ chuỗi sẽ được dần dần tự động.
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.