- Văn bản
- Lịch sử
The things that are most important
The things that are most important to document tend to be either (1) complicated and unpleasant and (2) things that you explain all the time. Sometimes,
an item is in both categories: for example, how to access the corporate intranet while traveling. We use the phrase complicated or unpleasant to refer
to both individual processes and the consequences if you make a mistake.
One good example is the process for setting up the IT presence of a new
employee: setting up the new hire’s computer; creating the accounts he needs,
including any department-specific aspects; whom to notify; and so on.
Thus, if a process has a lot of steps, especially ones for which the order
is significant—or messing up requires you to call your manager—it’s a good
idea to document it as soon as possible. You will be saving someone a lot of
trouble, and that someone could be you.
Documenting Disliked Processes
Tom finds that he’s bad at doing processes he dislikes. He gets distracted, forgets steps,
and so on. By documenting them as a checklist, he is less likely to skip a step and less
likely to make mistakes. It’s also easier to delegate the process to someone else once the
difficult work of creating the process is done.
Documenting the tasks that you disklike makes it easier to find someone
else to do them. Often, the difficult part is to create the process itself. Doing
the process then becomes easier. When we get permission to hire an additional
system administrator for our team, we are often tempted to hire someone with
the same skill set we have and to divide the work evenly. It can be difficult
to hire someone so senior. If we have documented the tasks that we dislike
doing, we can hire a junior person to do them and mentor the person over
time and promote from within. A junior person is less expensive and will
9.1 The Basics 243
eventually be someone with the knowledge of how the company and your IT
department works and the competency you’ve fostered.
A job description usually has two parts: the list of responsibilities and
the list of required skills. Generate the list of responsibilities by enumerating
the processes that you dislike and that have been documented. Generate the
list of required skills by drilling down into each document and cataloging
the skills and technologies an SA needs to be familiar with to understand the
documents. The entire job description basically writes itself.
9.1.2 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.
Case Study: Two Sets of Documentation
At Bell Labs, Cliff Miller created a system for maintaining a software depot for homogeneous UNIX environments. An important part of the depot’s design was the namespace used for the various packages, some of which would be visible only on certain
platforms or certain individual hosts. The process for adding software packages into
the namespace was a little tricky; although it was well documented, that documentation contained a lot of hand-holding verbiage. This was great the first time a package
was added but was cumbersome after that. His solution was to create a brief ‘‘quick
guide’’that included only the commands to be entered, with brief reminders of what
the person was doing and hypertext links to the appropriate section of the full documentation. Now, both new and experienced SAs could easily execute the process and
receive the right amount of documentation.
9.1.3 Easy Sources for Documentation
One way to make documenting your tasks easy is to take notes the next time
you do the task. Even if this slows down the process, it is easier than writing
the document from memory.
9.1.3.1 Saving Screen Shots
Learn how to use a tool for capturing screen shots. The next time you are
doing something that you’d like to have documented, take screen shots as
you perform each step. If you create the document from the screen shots, all
you need is a line or two of text for each picture, describing what is being
done in that step. Suddenly, you have a multimedia document, complete with
9.1 The Basics 245
visual aids. It’s another cross-check for correctness, since anyone using the
document can compare the screen shot to the real monitor at each step and
be satisfied that everything looks like it is supposed to before moving on.
9.1.3.2 Capturing the Command Line
If you are working on a command line rather than with a graphical interface,
copy and paste the terminal or console window into the document. Some
terminal or console window programs include a capture-to-file feature; the
UNIX script command captures entire sessions to a file.
The UNIX command history lists the last commands that were executed.
These saved commands can be the starting point for documenting a process,
by converting them into an automated script. Documentation is the first step
to automation: If you don’t know exactly how you do something, you can’t
automate it.
The combination of script and history is a powerful tool. The script
command gathers both what you type and what the computer puts out but
can, however, get obscured with odd characters if you use various aspects
of command line editing. The history command accurately shows the commands that were used and can be used to verify that they were recorded.
Whether you use a cut-and-paste ability or automatically capture output,
it’s better than retyping things from scratch. It is less work and more accurate.
9.1.3.3 Leveraging Email
How often do you have an email conversation with your coworkers about
a given task? Here’s a ready source of ad hoc documentation that can be
gathered together with a little work.
The two large problems with simply using email for your documentation
are that email is not easily shareable and is likely not well organized. Other
people cannot access your email, and you probably can’t always find what
you want. You’re unlikely to have a single piece of email that contains everything you want to have in a document. There is usually a larger message
and some back-and-forth smaller messages in which something is solved or
communicated. Combine those separate messages in one file, and put it where
your coworkers can find it.
If you already save a copy of every email you send, congratulations! You
have the material for a number of easy and helpful documents just waiting
for you to cut and paste them into the template mentioned in Section 9.1.2.
You can look in your Sent Mail folder for messages that can be used to
assemble a document on a topic. Use your email client’s ability to sort by
246 Chapter 9 Documentation
conversations or thread to find good potential emails to turn into documentation. If there were more than one or two exchanges on a topic, the conversation probably contains enough information to be worth turning into a
document. Even if your email client does not support conversations, sort by
the message subject.
9.1.3.4 Mining the Ticket System
Another good source of potential documentation is your organization’s
trouble-ticket or request-tracking system. Some of these systems include tools
to create a solutions database or solution documents that can be sent out when
new requests arrive that are similar to those already solved.
Many sites use software with a solutions database feature but never use
it or even enable it. It gets easier to use after the first couple times, so enable
it and use it now.
If you know that you’ll be using your ticket system as a resource when
writing documentation, you can make the process easier and the ticket information mo
an item is in both categories: for example, how to access the corporate intranet while traveling. We use the phrase complicated or unpleasant to refer
to both individual processes and the consequences if you make a mistake.
One good example is the process for setting up the IT presence of a new
employee: setting up the new hire’s computer; creating the accounts he needs,
including any department-specific aspects; whom to notify; and so on.
Thus, if a process has a lot of steps, especially ones for which the order
is significant—or messing up requires you to call your manager—it’s a good
idea to document it as soon as possible. You will be saving someone a lot of
trouble, and that someone could be you.
Documenting Disliked Processes
Tom finds that he’s bad at doing processes he dislikes. He gets distracted, forgets steps,
and so on. By documenting them as a checklist, he is less likely to skip a step and less
likely to make mistakes. It’s also easier to delegate the process to someone else once the
difficult work of creating the process is done.
Documenting the tasks that you disklike makes it easier to find someone
else to do them. Often, the difficult part is to create the process itself. Doing
the process then becomes easier. When we get permission to hire an additional
system administrator for our team, we are often tempted to hire someone with
the same skill set we have and to divide the work evenly. It can be difficult
to hire someone so senior. If we have documented the tasks that we dislike
doing, we can hire a junior person to do them and mentor the person over
time and promote from within. A junior person is less expensive and will
9.1 The Basics 243
eventually be someone with the knowledge of how the company and your IT
department works and the competency you’ve fostered.
A job description usually has two parts: the list of responsibilities and
the list of required skills. Generate the list of responsibilities by enumerating
the processes that you dislike and that have been documented. Generate the
list of required skills by drilling down into each document and cataloging
the skills and technologies an SA needs to be familiar with to understand the
documents. The entire job description basically writes itself.
9.1.2 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.
Case Study: Two Sets of Documentation
At Bell Labs, Cliff Miller created a system for maintaining a software depot for homogeneous UNIX environments. An important part of the depot’s design was the namespace used for the various packages, some of which would be visible only on certain
platforms or certain individual hosts. The process for adding software packages into
the namespace was a little tricky; although it was well documented, that documentation contained a lot of hand-holding verbiage. This was great the first time a package
was added but was cumbersome after that. His solution was to create a brief ‘‘quick
guide’’that included only the commands to be entered, with brief reminders of what
the person was doing and hypertext links to the appropriate section of the full documentation. Now, both new and experienced SAs could easily execute the process and
receive the right amount of documentation.
9.1.3 Easy Sources for Documentation
One way to make documenting your tasks easy is to take notes the next time
you do the task. Even if this slows down the process, it is easier than writing
the document from memory.
9.1.3.1 Saving Screen Shots
Learn how to use a tool for capturing screen shots. The next time you are
doing something that you’d like to have documented, take screen shots as
you perform each step. If you create the document from the screen shots, all
you need is a line or two of text for each picture, describing what is being
done in that step. Suddenly, you have a multimedia document, complete with
9.1 The Basics 245
visual aids. It’s another cross-check for correctness, since anyone using the
document can compare the screen shot to the real monitor at each step and
be satisfied that everything looks like it is supposed to before moving on.
9.1.3.2 Capturing the Command Line
If you are working on a command line rather than with a graphical interface,
copy and paste the terminal or console window into the document. Some
terminal or console window programs include a capture-to-file feature; the
UNIX script command captures entire sessions to a file.
The UNIX command history lists the last commands that were executed.
These saved commands can be the starting point for documenting a process,
by converting them into an automated script. Documentation is the first step
to automation: If you don’t know exactly how you do something, you can’t
automate it.
The combination of script and history is a powerful tool. The script
command gathers both what you type and what the computer puts out but
can, however, get obscured with odd characters if you use various aspects
of command line editing. The history command accurately shows the commands that were used and can be used to verify that they were recorded.
Whether you use a cut-and-paste ability or automatically capture output,
it’s better than retyping things from scratch. It is less work and more accurate.
9.1.3.3 Leveraging Email
How often do you have an email conversation with your coworkers about
a given task? Here’s a ready source of ad hoc documentation that can be
gathered together with a little work.
The two large problems with simply using email for your documentation
are that email is not easily shareable and is likely not well organized. Other
people cannot access your email, and you probably can’t always find what
you want. You’re unlikely to have a single piece of email that contains everything you want to have in a document. There is usually a larger message
and some back-and-forth smaller messages in which something is solved or
communicated. Combine those separate messages in one file, and put it where
your coworkers can find it.
If you already save a copy of every email you send, congratulations! You
have the material for a number of easy and helpful documents just waiting
for you to cut and paste them into the template mentioned in Section 9.1.2.
You can look in your Sent Mail folder for messages that can be used to
assemble a document on a topic. Use your email client’s ability to sort by
246 Chapter 9 Documentation
conversations or thread to find good potential emails to turn into documentation. If there were more than one or two exchanges on a topic, the conversation probably contains enough information to be worth turning into a
document. Even if your email client does not support conversations, sort by
the message subject.
9.1.3.4 Mining the Ticket System
Another good source of potential documentation is your organization’s
trouble-ticket or request-tracking system. Some of these systems include tools
to create a solutions database or solution documents that can be sent out when
new requests arrive that are similar to those already solved.
Many sites use software with a solutions database feature but never use
it or even enable it. It gets easier to use after the first couple times, so enable
it and use it now.
If you know that you’ll be using your ticket system as a resource when
writing documentation, you can make the process easier and the ticket information mo
0/5000
Những điều quan trọng nhất để tài liệu có xu hướng là một trong hai (1) phức tạp và khó chịu và (2) những điều mà bạn giải thích tất cả thời gian. Đôi khi,một mục là trong cả hai loại: ví dụ, làm thế nào để truy cập mạng nội bộ công ty trong khi đi du lịch. Chúng tôi sử dụng cụm từ phức tạp hoặc khó chịu để tham khảocả hai quá trình cá nhân và những hậu quả nếu bạn làm lỗi.Một ví dụ điển hình là quá trình để thiết lập sự hiện diện CNTT mớinhân viên: thiết lập máy tính thuê mới; tạo tài khoản ông nhu cầu,bao gồm bất kỳ khía cạnh cụ thể vùng; người mà thông báo cho; và như vậy.Vì vậy, nếu một quá trình có rất nhiều bước, đặc biệt là những người mà bộlà đáng kể- hoặc rối tung lên đòi hỏi bạn phải gọi quản lý của bạn-đó là một tốtý tưởng để tài liệu nó càng sớm càng tốt. Bạn sẽ có thể tiết kiệm một ai đó rất nhiềurắc rối, và rằng ai đó có thể là bạn.Tài liệu không thích quá trìnhTom thấy rằng ông là xấu lúc làm quá trình ông không thích. Ông bị phân tâm, quên bước,và như vậy. Bởi ghi lại chúng như là một danh sách kiểm tra, ông là ít có khả năng để bỏ qua một bước và ítcó khả năng để làm cho những sai lầm. Nó cũng là dễ dàng hơn để phân bổ quá trình cho người khác một lần cácCác công việc khó khăn của việc tạo ra quá trình được thực hiện.Tài liệu về các tác vụ mà bạn disklike làm cho nó dễ dàng hơn để tìm một ai đókhác để làm cho họ. Thông thường, một phần khó khăn là tạo ra quá trình tự nó. Làmquá trình này sau đó trở nên dễ dàng hơn. Khi chúng tôi nhận được sự cho phép để thuê một bổ sungquản trị hệ thống cho nhóm của chúng tôi, chúng tôi thường là cám dỗ để thuê một ai đó vớicùng một tập hợp kỹ năng hiện có và để phân chia công việc đồng đều. Nó có thể được khó khănthuê một ai đó rất cao cấp. Nếu chúng tôi có tài liệu các tác vụ mà chúng tôi không thíchlàm, chúng tôi có thể thuê một người học cơ sở để làm cho họ và cố vấn người trênthời gian và thúc đẩy từ bên trong. Một người học cơ sở là ít tốn kém và sẽ9.1 những điều cơ bản 243cuối cùng có một người có kiến thức về làm thế nào công ty và CNTT của bạnvùng hoạt động và khả năng bạn đã bồi dưỡng.Một mô tả công việc thường có hai phần: danh sách các trách nhiệm vàdanh sách các kỹ năng cần thiết. Tạo danh sách trách nhiệm bởi liệt kêcác quá trình mà bạn không thích và đó đã được ghi nhận. Tạo ra cácdanh sách các kỹ năng cần thiết bởi khoan xuống vào mỗi tài liệu và làm catalôcác kỹ năng và công nghệ SA một cần phải được làm quen với để hiểu cáctài liệu. Mô tả toàn bộ công việc cơ bản viết riêng của mình.9.1.2 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.Trường hợp nghiên cứu: Hai bộ của tài liệu hướng dẫnTại Phòng thí nghiệm Bell, Cliff Miller tạo ra một hệ thống cho việc duy trì một kho phần mềm cho đồng nhất UNIX môi trường. Một phần quan trọng của nhà kho thiết kế là không gian tên được sử dụng cho các gói khác nhau, một số trong đó sẽ được hiển thị chỉ trên một sốnền tảng hoặc máy chủ cá nhân nhất định. Quá trình thêm gói phần mềm vàokhông gian tên là một chút khôn lanh; mặc dù nó đã được tốt tài liệu, tài liệu đó chứa rất nhiều tay nắm giữ verbiage. Điều này là tuyệt vời lần đầu tiên một góiđã được bổ sung nhưng là rườm rà sau đó. Giải pháp của ông là tạo ra một giới thiệu tóm tắt '' nhanh chónghướng dẫn '' mà bao gồm chỉ các lệnh được nhập với các nhắc nhở ngắn gọn về những gìnhững người đã là thực hiện và siêu văn bản liên kết đến phần thích hợp của tài liệu hướng dẫn đầy đủ. Bây giờ, cả hai mới và kinh nghiệm SAs có thể dễ dàng thực hiện quá trình vànhận được số tiền phải của tài liệu hướng dẫn.9.1.3 dễ dàng nguồn tài liệuMột cách để làm cho tài liệu của bạn nhiệm vụ dễ dàng là để ghi chép thời gian tớibạn làm nhiệm vụ. Ngay cả nếu điều này làm chậm quá trình này, nó dễ dàng hơn bằng văn bảntài liệu từ bộ nhớ.9.1.3.1 ảnh chụp màn hình tiết kiệmTìm hiểu làm thế nào để sử dụng một công cụ cho việc chụp ảnh chụp màn hình. Khi bạn đanglàm một cái gì đó mà bạn muốn có tài liệu, hãy ảnh chụp màn hình nhưbạn thực hiện mỗi bước. Nếu bạn tạo ra các tài liệu từ các ảnh chụp màn hình, tất cảbạn cần là một dòng hoặc hai trong số các văn bản cho mỗi hình ảnh, mô tả những gì đangthực hiện trong bước đó. Đột nhiên, bạn có một đa phương tiện tài liệu, hoàn chỉnh với9.1 những điều cơ bản 245viện trợ trực quan. Nó là một chéo-kiểm tra cho đúng đắn, từ bất cứ ai sử dụng cáctài liệu có thể so sánh màn hình bắn để giám sát thực tại mỗi bước vàđược hài lòng rằng tất cả mọi thứ có vẻ như nó là nghĩa vụ phải trước khi di chuyển.9.1.3.2 bắt dòng lệnhNếu bạn đang làm việc trên một dòng lệnh hơn là với một giao diện đồ họa,sao chép và dán cửa sổ thiết bị đầu cuối hoặc giao diện điều khiển vào tài liệu. Một sốthiết bị đầu cuối hoặc giao diện điều khiển cửa sổ chương trình bao gồm một tính năng chụp tập tin; CácUNIX kịch bản lệnh bắt các phiên họp toàn bộ vào một tập tin.Lịch sử lệnh UNIX liệt kê các lệnh cuối cùng đã được thực hiện.Những lệnh này đã lưu có thể là điểm khởi đầu cho một quá trình, tài liệubằng cách chuyển đổi chúng thành một kịch bản tự động. Tài liệu là bước đầu tiênđể tự động hóa: nếu bạn không biết chính xác làm thế nào bạn làm điều gì đó, bạn có thể khôngtự động hoá nó.Sự kết hợp của kịch bản và lịch sử là một công cụ mạnh mẽ. Kịch bảnlệnh tập hợp cả những gì bạn gõ và những gì các máy tính đặt ra nhưngTuy nhiên, có thể, có được che khuất với ký tự lẻ nếu bạn sử dụng khía cạnh khác nhaudòng lệnh chỉnh sửa. Lệnh lịch sử chính xác Hiển thị các lệnh được sử dụng và có thể được sử dụng để xác minh rằng họ đã được ghi lại.Cho dù bạn sử dụng một khả năng cắt và dán hoặc tự động nắm bắt đầu ra,nó là tốt hơn so với retyping những thứ từ đầu. Nó là làm việc ít hơn và chính xác hơn.9.1.3.3 tận dụng EmailLàm thế nào thường làm bạn có một hội thoại email với đồng nghiệp của bạn vềmột nhiệm vụ nhất định? Đây là một nguồn sẵn sàng của quảng cáo hoc các tài liệu có thểtập hợp cùng với một chút công việc.Hai vấn đề lớn với chỉ đơn giản bằng cách sử dụng email cho tài liệu của bạnlà rằng email không phải là dễ dàng shareable và có khả năng được tổ chức không tốt. Khácnhững người không thể truy cập email của bạn, và bạn có thể không thể luôn luôn tìm những gìBạn muốn. Anh dường như không có một mảnh duy nhất của email có chứa tất cả mọi thứ bạn muốn có trong một tài liệu. Thường là thư lớn hơnvà một số thông điệp sau-và-ra nhỏ, trong đó một cái gì đó được giải quyết hoặctruyền đạt. Kết hợp những tin nhắn riêng biệt trong một tập tin, và đặt nó nơiđồng nghiệp của bạn có thể tìm thấy nó.Nếu bạn đã lưu một bản sao của tất cả các email bạn gửi, xin chúc mừng! Bạncó tài liệu cho một số dễ dàng và hữu ích tài liệu chỉ cần chờ đợiđể bạn có thể cắt và dán chúng vào các mẫu được đề cập trong phần 9.1.2.Bạn có thể xem trong cặp thư đã gửi của bạn về các thư có thể được sử dụng đểlắp ráp một tài liệu về một chủ đề. Sử dụng khả năng của ứng dụng email của bạn để sắp xếp theo246 chương 9 tài liệucuộc hội thoại hoặc các chủ đề để tìm tốt email tiềm năng để biến thành tài liệu. Nếu có nhiều hơn một hoặc hai trao đổi về một chủ đề, cuộc đàm thoại có thể chứa đủ thông tin có giá trị biến thành mộttài liệu. Ngay cả khi ứng dụng email của bạn không hỗ trợ các cuộc hội thoại, sắp xếp theochủ đề thư.9.1.3.4 khai thác hệ thống véMột nguồn tiềm năng tài liệu là tổ chức của bạnsự cố khi vé hoặc theo dõi yêu cầu hệ thống. Một số các hệ thống này bao gồm công cụđể tạo ra một giải pháp cơ sở dữ liệu hoặc tài liệu giải pháp có thể được gửi ra khiyêu cầu mới đến được tương tự như đã được giải quyết.Nhiều trang web sử dụng phần mềm với một giải pháp cơ sở dữ liệu tính năng nhưng không bao giờ sử dụngnó hoặc thậm chí kích hoạt nó. Nó được dễ dàng hơn để sử dụng sau vài lần đầu tiên, vì vậy cho phépnó và sử dụng nó bây giờ.Nếu bạn biết rằng bạn sẽ sử dụng hệ thống của bạn như là một nguồn tài nguyên khivăn bản tài liệu, bạn có thể làm cho quá trình dễ dàng hơn và lo vé thông tin mo
đang được dịch, vui lòng đợi..
Những điều quan trọng nhất đối với tài liệu có xu hướng là một trong hai (1) phức tạp và khó chịu và (2) những điều mà bạn giải thích tất cả các thời gian. Đôi khi,
một mục là trong cả hai loại: ví dụ, làm thế nào để truy cập vào mạng nội bộ của công ty khi đi du lịch. Chúng tôi sử dụng các cụm từ phức tạp hay khó chịu để tham khảo
cho cả quá trình cá nhân và các hậu quả nếu bạn thực hiện một sai lầm.
Một ví dụ điển hình là quá trình để thiết lập sự hiện diện của một IT mới
nhân viên: thiết lập máy tính người mới được tuyển; tạo ra các tài khoản ông cần,
bao gồm bất kỳ khía cạnh bộ phận cụ thể; mà thông báo; và như vậy.
Do đó, nếu một quá trình có rất nhiều bước, đặc biệt là những người mà theo thứ tự
là quan trọng hay rối tung lên đòi hỏi bạn phải gọi bạn quản lý-đó là một tốt
ý tưởng để tài liệu đó càng sớm càng tốt. Bạn sẽ tiết kiệm được một ai đó rất nhiều
rắc rối, và rằng ai đó có thể là bạn.
Tư liệu không thích các quá trình
Tom thấy rằng ông là xấu tại đang làm quá trình ông không thích. Ông bị phân tâm, quên bước,
và như vậy. Bằng cách ghi chúng như là một danh sách kiểm tra, ông ít có khả năng bỏ qua một bước và ít
có khả năng để làm cho những sai lầm. Nó cũng dễ dàng hơn để đại biểu quá trình này cho người khác một khi
công việc khó khăn của việc tạo ra quá trình này được thực hiện.
Ghi chép các công việc mà bạn disklike làm cho nó dễ dàng hơn để tìm thấy một người nào đó
khác để làm cho họ. Thông thường, phần khó khăn là để tạo ra quá trình tự nó. Làm
quá trình sau đó trở nên dễ dàng hơn. Khi chúng ta có được phép thuê thêm
người quản trị hệ thống cho đội ngũ của chúng tôi, chúng ta thường bị cám dỗ để thuê một ai đó với
các bộ kỹ năng cùng chúng ta có và để phân chia công việc đồng đều. Nó có thể là khó khăn
để thuê một ai đó rất cao cấp. Nếu chúng tôi đã ghi nhận những nhiệm vụ mà chúng ta không thích
làm, chúng ta có thể thuê một người học cơ sở để thực hiện chúng và cố vấn người qua
thời gian và thúc đẩy từ bên trong. Một người học là ít tốn kém và sẽ
9.1 Khái niệm cơ bản 243
cuối cùng là một người có kiến thức về cách các công ty và CNTT của
bạn. Phận này làm việc và năng lực bạn đã nuôi dưỡng
Một mô tả công việc thường có hai phần: danh sách trách nhiệm và
danh sách các yêu cầu kỹ năng. Tạo danh sách trách nhiệm bằng cách liệt kê
các quá trình mà bạn không thích và đã được ghi nhận. Tạo
danh sách các kỹ năng cần thiết bằng cách đi sâu vào từng tài liệu và lập danh mục
các kỹ năng và công nghệ một SA cần phải làm quen để hiểu các
tài liệu. Toàn bộ mô tả công việc cơ bản viết riêng của mình.
9.1.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.
Trường hợp nghiên cứu: Hai Bộ Tài liệu
Tại Bell Labs, Cliff Miller tạo ra một hệ thống để duy trì một kho phần mềm cho các môi trường UNIX đồng nhất. Một phần quan trọng của thiết kế của kho là không gian tên được sử dụng cho các gói khác nhau, một số trong đó sẽ được hiển thị chỉ trên một số
nền tảng hoặc một số máy chủ cá nhân. Quá trình để thêm các gói phần mềm vào
không gian tên là một chút khó khăn; mặc dù nó là tài liệu tốt, các tài liệu có chứa rất nhiều nắm tay nói dài giòng. Điều này là tuyệt vời lần đầu tiên một gói
đã được bổ sung nhưng cồng kềnh sau đó. Giải pháp của ông là tạo ra một '' nhanh chóng ngắn gọn
guide''that chỉ bao gồm các lệnh được nhập vào, với lời nhắc nhở ngắn gọn về những gì
người đó đã làm và các liên kết siêu văn bản đến các phần phù hợp trong tài liệu hướng dẫn đầy đủ. Bây giờ, cả hai mới và kinh nghiệm SAs có thể dễ dàng thực hiện quá trình và
nhận được số tiền phải của tài liệu.
9.1.3 Các nguồn dễ dàng cho Tài liệu
Một cách để làm cho tài liệu công việc của bạn dễ dàng là để ghi chép thời gian tiếp theo
bạn làm nhiệm vụ. Ngay cả nếu điều này làm chậm quá trình này, nó dễ hơn là viết
các tài liệu từ bộ nhớ.
9.1.3.1 Saving Screen Shots
Tìm hiểu làm thế nào để sử dụng một công cụ để chụp ảnh chụp màn hình. Lần tới khi bạn đang
làm một cái gì đó mà bạn muốn có tài liệu, chụp ảnh màn hình khi
bạn thực hiện từng bước. Nếu bạn tạo ra các tài liệu từ các ảnh chụp màn hình, tất cả
bạn cần là một hoặc hai dòng văn bản cho mỗi hình ảnh, mô tả những gì đang được
thực hiện trong bước này. Đột nhiên, bạn có một tài liệu đa phương tiện, hoàn chỉnh với
9.1 Khái niệm cơ bản 245
cụ trực quan. Đó là một cross-check cho đúng đắn, vì bất cứ ai sử dụng các
tài liệu có thể so sánh các ảnh chụp màn hình để màn hình thực tế tại mỗi bước và
được hài lòng tất cả mọi thứ có vẻ như nó là vụ phải trước khi chuyển.
9.1.3.2 Chụp Command Line
Nếu bạn là làm việc trên một dòng lệnh hơn là với một giao diện đồ họa,
sao chép và dán cửa sổ thiết bị đầu cuối hoặc console vào tài liệu. Một số
chương trình cửa sổ thiết bị đầu cuối hoặc giao diện điều khiển bao gồm một tính năng chụp-to-file; các
lệnh script UNIX chụp toàn bộ phiên vào một tập tin.
Lịch sử lệnh UNIX liệt kê các lệnh cuối cùng đã được thực hiện.
Những lệnh này được lưu có thể là điểm khởi đầu cho tài liệu một quá trình,
bằng cách chuyển đổi chúng thành một kịch bản tự động. Tài liệu là bước đầu tiên
để tự động hóa: Nếu bạn không biết chính xác làm thế nào bạn làm điều gì đó, bạn không thể
tự động hoá nó.
Sự kết hợp của kịch bản và lịch sử là một công cụ mạnh mẽ. Các kịch bản
lệnh tập hợp cả những gì bạn gõ và những gì các máy tính đặt ra nhưng
có thể, tuy nhiên, được che khuất với các nhân vật kỳ lạ nếu bạn sử dụng các khía cạnh khác nhau
của biên tập dòng lệnh. Các lệnh lịch sử cho thấy chính xác các lệnh đã được sử dụng và có thể được sử dụng để xác minh rằng họ đã được ghi.
Cho dù bạn sử dụng một khả năng cắt-và-dán hoặc tự động nắm bắt đầu ra,
nó là tốt hơn so với việc gõ lại mọi thứ từ đầu. Đó là công việc ít hơn và chính xác hơn.
9.1.3.3 Leveraging Email
Làm thế nào để bạn thường xuyên có một cuộc trò chuyện email với đồng nghiệp về
một nhiệm vụ nhất định? Dưới đây là một nguồn tài liệu sẵn sàng của ad hoc có thể được
tập hợp lại với nhau với một công việc rất ít.
Hai vấn đề lớn với chỉ đơn giản bằng cách sử dụng email cho tài liệu của bạn
được rằng email là không dễ dàng chia sẻ được và có thể không được tổ chức tốt. Khác
mọi người không thể truy cập vào email của bạn, và có thể bạn không thể luôn luôn tìm thấy những gì
bạn muốn. Bạn đang khó để có một mảnh duy nhất của email có chứa tất cả mọi thứ bạn muốn có trong một tài liệu. Thường có một thông điệp lớn hơn
và một số trở lại và ra thông điệp nhỏ hơn, trong đó một cái gì đó được giải quyết hoặc
truyền đạt. Kết hợp những thông điệp riêng biệt trong một tập tin, và đặt nó nơi
đồng nghiệp của bạn có thể tìm thấy nó.
Nếu bạn đã lưu một bản sao của mỗi email bạn gửi, xin chúc mừng! Bạn
có tài liệu cho một số tài liệu dễ dàng và hữu ích chỉ cần chờ đợi
cho bạn để cắt và dán chúng vào các mẫu nêu tại mục 9.1.2.
Bạn có thể tìm trong thư mục Thư đã gửi cho tin nhắn đó có thể được sử dụng để
lắp ráp một tài liệu trên một chủ đề. Sử dụng khả năng ứng dụng email của bạn để sắp xếp bởi
246 Chương 9 Tài liệu
hội thoại hay một chủ đề để tìm các email tiềm năng tốt để chuyển vào tài liệu. Nếu có nhiều hơn một hoặc hai sàn về một chủ đề, cuộc đàm thoại có thể chứa đủ thông tin để có giá trị chuyển vào một
tài liệu. Ngay cả khi ứng dụng email của bạn không hỗ trợ các cuộc trò chuyện, sắp xếp theo
các chủ đề thư.
9.1.3.4 Khai thác hệ thống Ticket
Một nguồn tốt của tài liệu tiềm năng là tổ chức của
hệ thống gặp sự cố vé hoặc yêu cầu theo dõi. Nhiều hệ thống này bao gồm các công cụ
để tạo ra một cơ sở dữ liệu các giải pháp hay tài liệu giải pháp mà có thể được gửi ra khi
yêu cầu mới đến mà là tương tự như đã được giải quyết.
Nhiều trang web sử dụng phần mềm với một tính năng giải pháp cơ sở dữ liệu nhưng không bao giờ sử dụng
nó hoặc thậm chí cho phép nó. Nó được dễ dàng hơn để sử dụng sau vài lần đầu tiên, do đó cho phép
nó và sử dụng nó ngay bây giờ.
Nếu bạn biết rằng bạn sẽ sử dụng hệ thống bán vé của bạn như là một nguồn tài nguyên khi
viết tài liệu, bạn có thể làm cho quá trình dễ dàng hơn và mo thông tin về vé
một mục là trong cả hai loại: ví dụ, làm thế nào để truy cập vào mạng nội bộ của công ty khi đi du lịch. Chúng tôi sử dụng các cụm từ phức tạp hay khó chịu để tham khảo
cho cả quá trình cá nhân và các hậu quả nếu bạn thực hiện một sai lầm.
Một ví dụ điển hình là quá trình để thiết lập sự hiện diện của một IT mới
nhân viên: thiết lập máy tính người mới được tuyển; tạo ra các tài khoản ông cần,
bao gồm bất kỳ khía cạnh bộ phận cụ thể; mà thông báo; và như vậy.
Do đó, nếu một quá trình có rất nhiều bước, đặc biệt là những người mà theo thứ tự
là quan trọng hay rối tung lên đòi hỏi bạn phải gọi bạn quản lý-đó là một tốt
ý tưởng để tài liệu đó càng sớm càng tốt. Bạn sẽ tiết kiệm được một ai đó rất nhiều
rắc rối, và rằng ai đó có thể là bạn.
Tư liệu không thích các quá trình
Tom thấy rằng ông là xấu tại đang làm quá trình ông không thích. Ông bị phân tâm, quên bước,
và như vậy. Bằng cách ghi chúng như là một danh sách kiểm tra, ông ít có khả năng bỏ qua một bước và ít
có khả năng để làm cho những sai lầm. Nó cũng dễ dàng hơn để đại biểu quá trình này cho người khác một khi
công việc khó khăn của việc tạo ra quá trình này được thực hiện.
Ghi chép các công việc mà bạn disklike làm cho nó dễ dàng hơn để tìm thấy một người nào đó
khác để làm cho họ. Thông thường, phần khó khăn là để tạo ra quá trình tự nó. Làm
quá trình sau đó trở nên dễ dàng hơn. Khi chúng ta có được phép thuê thêm
người quản trị hệ thống cho đội ngũ của chúng tôi, chúng ta thường bị cám dỗ để thuê một ai đó với
các bộ kỹ năng cùng chúng ta có và để phân chia công việc đồng đều. Nó có thể là khó khăn
để thuê một ai đó rất cao cấp. Nếu chúng tôi đã ghi nhận những nhiệm vụ mà chúng ta không thích
làm, chúng ta có thể thuê một người học cơ sở để thực hiện chúng và cố vấn người qua
thời gian và thúc đẩy từ bên trong. Một người học là ít tốn kém và sẽ
9.1 Khái niệm cơ bản 243
cuối cùng là một người có kiến thức về cách các công ty và CNTT của
bạn. Phận này làm việc và năng lực bạn đã nuôi dưỡng
Một mô tả công việc thường có hai phần: danh sách trách nhiệm và
danh sách các yêu cầu kỹ năng. Tạo danh sách trách nhiệm bằng cách liệt kê
các quá trình mà bạn không thích và đã được ghi nhận. Tạo
danh sách các kỹ năng cần thiết bằng cách đi sâu vào từng tài liệu và lập danh mục
các kỹ năng và công nghệ một SA cần phải làm quen để hiểu các
tài liệu. Toàn bộ mô tả công việc cơ bản viết riêng của mình.
9.1.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.
Trường hợp nghiên cứu: Hai Bộ Tài liệu
Tại Bell Labs, Cliff Miller tạo ra một hệ thống để duy trì một kho phần mềm cho các môi trường UNIX đồng nhất. Một phần quan trọng của thiết kế của kho là không gian tên được sử dụng cho các gói khác nhau, một số trong đó sẽ được hiển thị chỉ trên một số
nền tảng hoặc một số máy chủ cá nhân. Quá trình để thêm các gói phần mềm vào
không gian tên là một chút khó khăn; mặc dù nó là tài liệu tốt, các tài liệu có chứa rất nhiều nắm tay nói dài giòng. Điều này là tuyệt vời lần đầu tiên một gói
đã được bổ sung nhưng cồng kềnh sau đó. Giải pháp của ông là tạo ra một '' nhanh chóng ngắn gọn
guide''that chỉ bao gồm các lệnh được nhập vào, với lời nhắc nhở ngắn gọn về những gì
người đó đã làm và các liên kết siêu văn bản đến các phần phù hợp trong tài liệu hướng dẫn đầy đủ. Bây giờ, cả hai mới và kinh nghiệm SAs có thể dễ dàng thực hiện quá trình và
nhận được số tiền phải của tài liệu.
9.1.3 Các nguồn dễ dàng cho Tài liệu
Một cách để làm cho tài liệu công việc của bạn dễ dàng là để ghi chép thời gian tiếp theo
bạn làm nhiệm vụ. Ngay cả nếu điều này làm chậm quá trình này, nó dễ hơn là viết
các tài liệu từ bộ nhớ.
9.1.3.1 Saving Screen Shots
Tìm hiểu làm thế nào để sử dụng một công cụ để chụp ảnh chụp màn hình. Lần tới khi bạn đang
làm một cái gì đó mà bạn muốn có tài liệu, chụp ảnh màn hình khi
bạn thực hiện từng bước. Nếu bạn tạo ra các tài liệu từ các ảnh chụp màn hình, tất cả
bạn cần là một hoặc hai dòng văn bản cho mỗi hình ảnh, mô tả những gì đang được
thực hiện trong bước này. Đột nhiên, bạn có một tài liệu đa phương tiện, hoàn chỉnh với
9.1 Khái niệm cơ bản 245
cụ trực quan. Đó là một cross-check cho đúng đắn, vì bất cứ ai sử dụng các
tài liệu có thể so sánh các ảnh chụp màn hình để màn hình thực tế tại mỗi bước và
được hài lòng tất cả mọi thứ có vẻ như nó là vụ phải trước khi chuyển.
9.1.3.2 Chụp Command Line
Nếu bạn là làm việc trên một dòng lệnh hơn là với một giao diện đồ họa,
sao chép và dán cửa sổ thiết bị đầu cuối hoặc console vào tài liệu. Một số
chương trình cửa sổ thiết bị đầu cuối hoặc giao diện điều khiển bao gồm một tính năng chụp-to-file; các
lệnh script UNIX chụp toàn bộ phiên vào một tập tin.
Lịch sử lệnh UNIX liệt kê các lệnh cuối cùng đã được thực hiện.
Những lệnh này được lưu có thể là điểm khởi đầu cho tài liệu một quá trình,
bằng cách chuyển đổi chúng thành một kịch bản tự động. Tài liệu là bước đầu tiên
để tự động hóa: Nếu bạn không biết chính xác làm thế nào bạn làm điều gì đó, bạn không thể
tự động hoá nó.
Sự kết hợp của kịch bản và lịch sử là một công cụ mạnh mẽ. Các kịch bản
lệnh tập hợp cả những gì bạn gõ và những gì các máy tính đặt ra nhưng
có thể, tuy nhiên, được che khuất với các nhân vật kỳ lạ nếu bạn sử dụng các khía cạnh khác nhau
của biên tập dòng lệnh. Các lệnh lịch sử cho thấy chính xác các lệnh đã được sử dụng và có thể được sử dụng để xác minh rằng họ đã được ghi.
Cho dù bạn sử dụng một khả năng cắt-và-dán hoặc tự động nắm bắt đầu ra,
nó là tốt hơn so với việc gõ lại mọi thứ từ đầu. Đó là công việc ít hơn và chính xác hơn.
9.1.3.3 Leveraging Email
Làm thế nào để bạn thường xuyên có một cuộc trò chuyện email với đồng nghiệp về
một nhiệm vụ nhất định? Dưới đây là một nguồn tài liệu sẵn sàng của ad hoc có thể được
tập hợp lại với nhau với một công việc rất ít.
Hai vấn đề lớn với chỉ đơn giản bằng cách sử dụng email cho tài liệu của bạn
được rằng email là không dễ dàng chia sẻ được và có thể không được tổ chức tốt. Khác
mọi người không thể truy cập vào email của bạn, và có thể bạn không thể luôn luôn tìm thấy những gì
bạn muốn. Bạn đang khó để có một mảnh duy nhất của email có chứa tất cả mọi thứ bạn muốn có trong một tài liệu. Thường có một thông điệp lớn hơn
và một số trở lại và ra thông điệp nhỏ hơn, trong đó một cái gì đó được giải quyết hoặc
truyền đạt. Kết hợp những thông điệp riêng biệt trong một tập tin, và đặt nó nơi
đồng nghiệp của bạn có thể tìm thấy nó.
Nếu bạn đã lưu một bản sao của mỗi email bạn gửi, xin chúc mừng! Bạn
có tài liệu cho một số tài liệu dễ dàng và hữu ích chỉ cần chờ đợi
cho bạn để cắt và dán chúng vào các mẫu nêu tại mục 9.1.2.
Bạn có thể tìm trong thư mục Thư đã gửi cho tin nhắn đó có thể được sử dụng để
lắp ráp một tài liệu trên một chủ đề. Sử dụng khả năng ứng dụng email của bạn để sắp xếp bởi
246 Chương 9 Tài liệu
hội thoại hay một chủ đề để tìm các email tiềm năng tốt để chuyển vào tài liệu. Nếu có nhiều hơn một hoặc hai sàn về một chủ đề, cuộc đàm thoại có thể chứa đủ thông tin để có giá trị chuyển vào một
tài liệu. Ngay cả khi ứng dụng email của bạn không hỗ trợ các cuộc trò chuyện, sắp xếp theo
các chủ đề thư.
9.1.3.4 Khai thác hệ thống Ticket
Một nguồn tốt của tài liệu tiềm năng là tổ chức của
hệ thống gặp sự cố vé hoặc yêu cầu theo dõi. Nhiều hệ thống này bao gồm các công cụ
để tạo ra một cơ sở dữ liệu các giải pháp hay tài liệu giải pháp mà có thể được gửi ra khi
yêu cầu mới đến mà là tương tự như đã được giải quyết.
Nhiều trang web sử dụng phần mềm với một tính năng giải pháp cơ sở dữ liệu nhưng không bao giờ sử dụng
nó hoặc thậm chí cho phép nó. Nó được dễ dàng hơn để sử dụng sau vài lần đầu tiên, do đó cho phép
nó và sử dụng nó ngay bây giờ.
Nếu bạn biết rằng bạn sẽ sử dụng hệ thống bán vé của bạn như là một nguồn tài nguyên khi
viết tài liệu, bạn có thể làm cho quá trình dễ dàng hơn và mo thông tin về vé
đang được dịch, vui lòng đợi..
Các ngôn ngữ khác
Hỗ trợ công cụ dịch thuật: Albania, Amharic, Anh, Armenia, Azerbaijan, Ba Lan, Ba Tư, Bantu, Basque, Belarus, Bengal, Bosnia, Bulgaria, Bồ Đào Nha, Catalan, Cebuano, Chichewa, Corsi, Creole (Haiti), Croatia, Do Thái, Estonia, Filipino, Frisia, Gael Scotland, Galicia, George, Gujarat, Hausa, Hawaii, Hindi, Hmong, Hungary, Hy Lạp, Hà Lan, Hà Lan (Nam Phi), Hàn, Iceland, Igbo, Ireland, Java, Kannada, Kazakh, Khmer, Kinyarwanda, Klingon, Kurd, Kyrgyz, Latinh, Latvia, Litva, Luxembourg, Lào, Macedonia, Malagasy, Malayalam, Malta, Maori, Marathi, Myanmar, Mã Lai, Mông Cổ, Na Uy, Nepal, Nga, Nhật, Odia (Oriya), Pashto, Pháp, Phát hiện ngôn ngữ, Phần Lan, Punjab, Quốc tế ngữ, Rumani, Samoa, Serbia, Sesotho, Shona, Sindhi, Sinhala, Slovak, Slovenia, Somali, Sunda, Swahili, Séc, Tajik, Tamil, Tatar, Telugu, Thái, Thổ Nhĩ Kỳ, Thụy Điển, Tiếng Indonesia, Tiếng Ý, Trung, Trung (Phồn thể), Turkmen, Tây Ban Nha, Ukraina, Urdu, Uyghur, Uzbek, Việt, Xứ Wales, Yiddish, Yoruba, Zulu, Đan Mạch, Đức, Ả Rập, dịch ngôn ngữ.
- Investment Adviser
- Valentine's Day is not a public holiday.
- tôi không muốn nhìn thấy em buồn
- - Bữa ăn đầy đủ, cân đối theo khẩu phần
- Nhớ không lầm! Bạn là đầu bếp ở nhà hàng
- rút gọn link
- Saya tidak ingin melihat Anda sedih
- screen
- Bị tấn công tiếp mọi người cẩn thận
- - Bữa ăn đầy đủ, cân đối theo khẩu phần
- Peaux deshydratees
- em nhớ anh
- Lá Yin
- You still have those photos... i cam't b
- Heathcliff’s origins
- 大きな蟷螂
- 主要用于棉花、花生等作物的地膜覆盖栽培。有两种类型：一种是先播种后铺膜，由播种机
- Tôi cảm thấy buồn khi sắp xa bạn.huhu
- ăn nhiều rau
- 殷叶子
- nó rất tự nhiên và yên tĩnh
- nhiều rau
- The king of Goguryeo has advancednear Wi
- 女神
