A Simple Template for Getting Start

A Simple Template for Getting Started
The most difficult part of creating a document is getting started. Here’s a
simple formula: Identify the four basic elements of a piece of documentation:
title, metadata, what, and how. Create a document template or outline, and
then fill in the sections from start to end.
1. Title: A simple title that others will understand.
2. Metadata: The document’s author—usually your—contact information, and revision date or history. People reading the document will be
able to contact the author with questions and when you get promoted,
and your successors will honor you as the person who gifted them
with this document. The revision date and history will help people
understand whether the document is still relevant.
3. What: A sentence describing the contents of the document or the goal
that someone can achieve by following the directions. One or two
sentences is fine.
4. How: The steps to take to accomplish the goal. For any step that seems
mysterious or confusing, you might add a why, such as “Re-tension
the tape (Why? Because we find that on a full backup, we get tape
errors less often if we have done so, even with a new tape).”
Next, do some basic quality assurance (QA) on the document. Accuracy
is important. A typo or a skipped step could result in someone’s creating more
problems than the document seeks to fix.
Follow the steps in the document yourself, typing each command, and so
on. Next, have someone else use your document to accomplish the goal and
to give you feedback on where he had any problems. Give the person a copy
on paper, making it more likely that the person will take notes to give back
to you.
244 Chapter 9 Documentation
Although it is possible to do this interactively, with you watching and
writing down the person’s feedback, it’s easy to have the session turn into
a conversation, with you helping the person along with the process, taking
mental notes to write down when you get back to your desk. Be strict with
yourself: If you don’t let the person do the work, he is not testing your instructions. If the person is comfortable with you watching, sit out of view
and watch, taking notes on what causes confusion.
After a few people have successfully used this documentation, use it to
create a shorter “quick guide” that summarizes the steps. This guide simply
helps the experienced SA not to forget anything. The SA should be able to cut
and paste command lines from this document into a shell so that the process
goes quickly.

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

Một khuôn mẫu đơn giản để bắt đầuPhần khó khăn nhất của việc tạo ra một tài liệu bắt đầu. Đây là mộtcông thức đơn giản: xác định bốn yếu tố cơ bản của một phần của tài liệu:tiêu đề, siêu dữ liệu, những gì, và làm thế nào. Tạo một tài liệu mẫu hoặc phác thảo, vàsau đó điền vào các phần từ đầu đến kết thúc.1. tiêu đề: Một tiêu đề đơn giản mà những người khác sẽ hiểu.2. siêu dữ liệu: Tác giả của tài liệu — thông thường của bạn-liên hệ với thông tin, và sửa đổi ngày hoặc lịch sử. Những người đọc các tài liệu sẽcó thể liên hệ với tác giả với câu hỏi và khi bạn nhận được lên,và những người kế vị của bạn sẽ tôn vinh bạn là người có năng khiếu chúngvới tài liệu này. Sửa đổi ngày và lịch sử sẽ giúp mọi ngườihiểu cho dù các tài liệu có liên quan vẫn còn.3. những gì: Một câu mô tả nội dung của tài liệu hoặc mục tiêurằng ai đó có thể đạt được bằng cách làm theo các hướng dẫn. Một hoặc haicâu là tốt.4. làm thế nào: Các bước để có để đạt mục tiêu. Cho bất kỳ bước nào có vẻbí ẩn hoặc khó hiểu, bạn có thể thêm một lý do tại sao, chẳng hạn như "căng lạibăng (lý do tại sao? Bởi vì chúng tôi thấy rằng trên một sao lưu đầy đủ, chúng tôi nhận được bănglỗi ít thường xuyên hơn nếu chúng tôi đã làm như vậy, ngay cả với một băng mới). "Tiếp theo, làm một số cơ bản chất lượng (QA) tài liệu. Độ chính xáclà quan trọng. Một lỗi đánh máy hoặc đã bỏ qua bước có thể dẫn đến của một ai đó tạo thêmvấn đề hơn tài liệu tìm kiếm để sửa chữa.Làm theo các bước trong tài liệu chính mình, gõ mỗi lệnh, và như vậyngày. Tiếp theo, có một người nào khác sử dụng tài liệu của bạn để đạt mục tiêu vàđể cung cấp cho bạn thông tin phản hồi trên nơi ông đã có bất kỳ vấn đề. Cung cấp cho người một bản saotrên giấy, làm cho nó nhiều khả năng rằng những người sẽ đưa các ghi chú để cho trở lạicho bạn.244 chương 9 tài liệuMặc dù nó có thể làm điều này một cách tương tác, với bạn xem vàviết xuống các thông tin phản hồi của người, thật dễ dàng để có phiên biến thànhmột cuộc trò chuyện với bạn giúp đỡ những người cùng với quá trình, tham giaghi chú tâm thần để ghi lại khi bạn nhận được trở lại bàn làm việc của bạn. Được nghiêm ngặt vớibản thân bạn: nếu bạn không cho phép những người làm việc, ông không phải thử nghiệm hướng dẫn của bạn. Nếu người đó là thoải mái với bạn xem, ngồi ra khỏi xemvà xem, ghi chú trên những gì gây ra sự nhầm lẫn.Sau khi một vài người đã thành công sử dụng tài liệu này, sử dụng nó đểtạo một ngắn hơn "hướng dẫn nhanh" mà tóm tắt các bước. Điều này hướng dẫn đơn giảngiúp SA có kinh nghiệm không phải để quên bất cứ điều gì. SA sẽ có thể cắtvà dán lệnh dòng từ đây tài liệu vào một vỏ vì vậy mà quá trìnhđi một cách nhanh chóng.

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

Một mẫu đơn giản để Bắt đầu
Phần khó nhất của việc tạo ra một tài liệu được bắt đầu. Dưới đây là một
công thức đơn giản: Xác định bốn yếu tố cơ bản của một phần tài liệu:
tiêu đề, siêu dữ liệu, những gì, và làm thế nào. Tạo một mẫu tài liệu hoặc phác thảo, và
sau đó điền vào các phần từ đầu đến cuối.
1. Tiêu đề: Một tiêu đề đơn giản mà những người khác sẽ hiểu.
2. Metadata: thông tin tác giả-thường của bạn tiếp xúc Các tài liệu, và ngày sửa đổi hay lịch sử. Người đọc tài liệu sẽ
có thể liên hệ với tác giả với những câu hỏi và khi bạn được thăng tiến,
và những người kế của bạn sẽ tôn trọng bạn như là người có năng khiếu chúng
với tài liệu này. Những ngày sửa đổi và lịch sử sẽ giúp mọi người
hiểu xem tài liệu vẫn còn có liên quan.
3. Có gì: Một câu mô tả nội dung của các tài liệu hoặc các mục tiêu
mà ai đó có thể đạt được bằng cách làm theo các hướng dẫn. Một hoặc hai
câu là tốt.
4. Làm thế nào: Các bước cần thực hiện để hoàn thành mục tiêu. Đối với bất cứ bước nào đó có vẻ
bí ẩn hoặc khó hiểu, bạn có thể thêm một lý do, chẳng hạn như "Re-căng
băng (Tại sao? Bởi vì chúng tôi thấy rằng trên một bản sao lưu đầy đủ, chúng tôi nhận được băng
lỗi ít thường xuyên hơn nếu chúng tôi đã làm như vậy, ngay cả với một băng mới).
"Tiếp theo, làm một số bảo đảm chất lượng cơ bản (QA) trên tài liệu. Độ chính xác
là rất quan trọng. Một lỗi đánh máy hoặc một bước bỏ qua có thể dẫn đến một ai đó tạo ra nhiều
vấn đề hơn là các tài liệu tìm cách khắc phục.
Thực hiện theo các bước trong các tài liệu chính mình, gõ từng lệnh, và do đó
trên. Tiếp theo, có người khác sử dụng tài liệu của bạn để hoàn thành mục tiêu và
cung cấp cho bạn thông tin phản hồi về nơi mà ông có bất kỳ vấn đề. Cho người này một bản sao
trên giấy, làm cho nó nhiều khả năng người đó sẽ ghi chép để trả lại
cho bạn.
244 Chương 9 Tài liệu
Mặc dù nó có thể làm điều này một cách tương tác, với bạn xem và
ghi lại thông tin phản hồi của người đó, thật dễ dàng để có phiên biến thành
một cuộc trò chuyện với bạn giúp đỡ người cùng với quá trình này, việc
ghi chú về tinh thần để viết xuống khi bạn nhận được trở lại để bàn của bạn. Nghiêm khắc với
bản thân: Nếu bạn không cho người làm việc, anh không được kiểm tra hướng dẫn của bạn. Nếu người đó là thoải mái với bạn xem, ngồi ngoài tầm nhìn
và quan sát, ghi chép về những gì gây nhầm lẫn.
Sau một vài người đã sử dụng thành công tài liệu này, hãy sử dụng nó để
tạo ra một "hướng dẫn nhanh chóng" ngắn tóm tắt các bước. Hướng dẫn này chỉ đơn giản là
giúp các SA có kinh nghiệm không quên bất cứ điều gì. Các SA sẽ có thể cắt
và dán dòng lệnh từ tài liệu này sang một vỏ để quá trình
đi một cách nhanh chóng.