- Văn bản
- Lịch sử
In system administration terms, doc
In system administration terms, documentation means keeping records of
where things are, explaining how to do things, and making useful information available to customers. In general, SAs dislike writing documentation:
There’s hardly enough time to do the work; why write documentation, too?
The reason is that documentation helps in many ways, and a lack of documentation hurts SAs’ ability to do a good job.
It can be difficult to decide what to document. We recommend being
selfish: Use documentation as a tool to make your work easier. Is the helpdesk
flooded with the same few questions over and over? Provide documentation
so that customers can help themselves. Are there tasks that you dislike doing?
Document them so it is easier to delegate them or to have a junior SA take them
over. Do you find it difficult to relax while on vacation? Do you skip vacations
altogether? Document the processes that only you can do. Do you spend days
fixing mistakes that could have been prevented? Maintain checklists and hint
sheets to improve repeatability.
Documentation is a way of creating an institutional memory that lets an
SA team increase its knowledge and skill level. Think of documentation as
RAID for the SA staff: It gives you redundancy in the group. Some SAs fear
that documentation will make them more replaceable and therefore refuse to
document what they do. As a result, they often eventually feel trapped, cornered, and unable to leave their position. They get stressed and, ironically,
quit out of frustration. The truth is that, because it simultaneously retains
and shares knowledge, documentation enables an organization to promote
people from within.
This chapter offers advice about how to create documentation, how to
store it and make it available, and how to manage larger and larger repositories. We stress techniques for making it easy to create documentation by
241
242 Chapter 9 Documentation
reducing the barriers, real and mental, that prevent people from maintaining
documentation.
9.1 The Basics
The basics involve having some easy ways to create documentation, store it
so that it’s easily used, and make it available to everyone who might need it.
9.1.1 What to Document
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 phrasecomplicated or unpleasantto 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,andhow.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 awhy, 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 UNIXenvironments. 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
UNIXscriptcommand captures entire sessions to a file.
The UNIXcommandhistorylists 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 ofscriptandhistoryis 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. Thehistorycommand 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
where things are, explaining how to do things, and making useful information available to customers. In general, SAs dislike writing documentation:
There’s hardly enough time to do the work; why write documentation, too?
The reason is that documentation helps in many ways, and a lack of documentation hurts SAs’ ability to do a good job.
It can be difficult to decide what to document. We recommend being
selfish: Use documentation as a tool to make your work easier. Is the helpdesk
flooded with the same few questions over and over? Provide documentation
so that customers can help themselves. Are there tasks that you dislike doing?
Document them so it is easier to delegate them or to have a junior SA take them
over. Do you find it difficult to relax while on vacation? Do you skip vacations
altogether? Document the processes that only you can do. Do you spend days
fixing mistakes that could have been prevented? Maintain checklists and hint
sheets to improve repeatability.
Documentation is a way of creating an institutional memory that lets an
SA team increase its knowledge and skill level. Think of documentation as
RAID for the SA staff: It gives you redundancy in the group. Some SAs fear
that documentation will make them more replaceable and therefore refuse to
document what they do. As a result, they often eventually feel trapped, cornered, and unable to leave their position. They get stressed and, ironically,
quit out of frustration. The truth is that, because it simultaneously retains
and shares knowledge, documentation enables an organization to promote
people from within.
This chapter offers advice about how to create documentation, how to
store it and make it available, and how to manage larger and larger repositories. We stress techniques for making it easy to create documentation by
241
242 Chapter 9 Documentation
reducing the barriers, real and mental, that prevent people from maintaining
documentation.
9.1 The Basics
The basics involve having some easy ways to create documentation, store it
so that it’s easily used, and make it available to everyone who might need it.
9.1.1 What to Document
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 phrasecomplicated or unpleasantto 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,andhow.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 awhy, 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 UNIXenvironments. 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
UNIXscriptcommand captures entire sessions to a file.
The UNIXcommandhistorylists 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 ofscriptandhistoryis 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. Thehistorycommand 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
0/5000
In system administration terms, documentation means keeping records ofwhere things are, explaining how to do things, and making useful information available to customers. In general, SAs dislike writing documentation:There’s hardly enough time to do the work; why write documentation, too?The reason is that documentation helps in many ways, and a lack of documentation hurts SAs’ ability to do a good job.It can be difficult to decide what to document. We recommend beingselfish: Use documentation as a tool to make your work easier. Is the helpdeskflooded with the same few questions over and over? Provide documentationso that customers can help themselves. Are there tasks that you dislike doing?Document them so it is easier to delegate them or to have a junior SA take themover. Do you find it difficult to relax while on vacation? Do you skip vacationsaltogether? Document the processes that only you can do. Do you spend daysfixing mistakes that could have been prevented? Maintain checklists and hintsheets to improve repeatability.Documentation is a way of creating an institutional memory that lets anSA team increase its knowledge and skill level. Think of documentation asRAID for the SA staff: It gives you redundancy in the group. Some SAs fearthat documentation will make them more replaceable and therefore refuse todocument what they do. As a result, they often eventually feel trapped, cornered, and unable to leave their position. They get stressed and, ironically,quit out of frustration. The truth is that, because it simultaneously retainsand shares knowledge, documentation enables an organization to promotepeople from within.This chapter offers advice about how to create documentation, how tostore it and make it available, and how to manage larger and larger repositories. We stress techniques for making it easy to create documentation by241242 Chapter 9 Documentationreducing the barriers, real and mental, that prevent people from maintainingdocumentation.9.1 The BasicsThe basics involve having some easy ways to create documentation, store itso that it’s easily used, and make it available to everyone who might need it.9.1.1 What to DocumentThe 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 phrasecomplicated or unpleasantto referto 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 newemployee: 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 orderis significant—or messing up requires you to call your manager—it’s a goodidea to document it as soon as possible. You will be saving someone a lot oftrouble, and that someone could be you.Documenting Disliked ProcessesTom 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 lesslikely to make mistakes. It’s also easier to delegate the process to someone else once thedifficult work of creating the process is done.Documenting the tasks that you disklike makes it easier to find someoneelse to do them. Often, the difficult part is to create the process itself. Doingthe process then becomes easier. When we get permission to hire an additionalsystem administrator for our team, we are often tempted to hire someone withthe same skill set we have and to divide the work evenly. It can be difficultto hire someone so senior. If we have documented the tasks that we dislikedoing, we can hire a junior person to do them and mentor the person overtime and promote from within. A junior person is less expensive and will9.1 The Basics 243eventually be someone with the knowledge of how the company and your ITdepartment works and the competency you’ve fostered.A job description usually has two parts: the list of responsibilities andthe list of required skills. Generate the list of responsibilities by enumeratingthe processes that you dislike and that have been documented. Generate thelist of required skills by drilling down into each document and catalogingthe skills and technologies an SA needs to be familiar with to understand thedocuments. The entire job description basically writes itself.9.1.2 A Simple Template for Getting StartedThe most difficult part of creating a document is getting started. Here’s asimple formula: Identify the four basic elements of a piece of documentation:title, metadata, what,andhow.Create a document template or outline, andthen 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 beable to contact the author with questions and when you get promoted,and your successors will honor you as the person who gifted themwith this document. The revision date and history will help peopleunderstand whether the document is still relevant.3.What:A sentence describing the contents of the document or the goalthat someone can achieve by following the directions. One or twosentences is fine.4.How:The steps to take to accomplish the goal. For any step that seemsmysterious or confusing, you might add awhy, such as “Re-tensionthe tape (Why? Because we find that on a full backup, we get tapeerrors less often if we have done so, even with a new tape).”Next, do some basic quality assurance (QA) on the document. Accuracyis 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 UNIXenvironments. 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
UNIXscriptcommand captures entire sessions to a file.
The UNIXcommandhistorylists 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 ofscriptandhistoryis 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. Thehistorycommand 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
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 UNIXenvironments. 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
UNIXscriptcommand captures entire sessions to a file.
The UNIXcommandhistorylists 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 ofscriptandhistoryis 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. Thehistorycommand 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
đang được dịch, vui lòng đợi..
Về quản trị hệ thống, tài liệu hướng dẫn có nghĩa là hồ sơ lưu
giữ, nơi mọi thứ đang có, giải thích làm thế nào để làm điều đó, và làm cho thông tin hữu ích có sẵn cho khách hàng. Nói chung, tài liệu SAs không thích bằng văn bản:
Có hầu như không đủ thời gian để làm công việc; tại sao viết tài liệu, quá?
Lý do là tài liệu giúp bằng nhiều cách, và một thiếu tài liệu khả năng đau SAs 'để làm một công việc tốt.
Nó có thể được khó khăn để quyết định những gì đến tài liệu. Chúng tôi đề nghị là
ích kỷ: Sử dụng các tài liệu như một công cụ để làm cho công việc của bạn dễ dàng hơn. Sản helpdesk
ngập với những câu hỏi tương tự hơn và hơn? Cung cấp tài liệu
để khách hàng có thể tự giúp mình. Có những công việc mà bạn không thích làm gì?
Tài liệu chúng vì vậy nó là dễ dàng hơn để đại biểu họ hay để có một cơ sở SA đưa họ
hơn. Bạn có cảm thấy khó khăn để thư giãn trong khi đi nghỉ? Bạn bỏ qua những kỳ nghỉ
hoàn toàn? Tài liệu về quy trình mà chỉ có bạn có thể làm. Bạn dành cả ngày
sửa chữa những sai lầm mà có thể đã được ngăn chặn? Duy trì danh sách kiểm tra và gợi ý
tờ để cải thiện khả năng lặp lại.
Tài liệu là một cách để tạo ra một bộ nhớ thể chế cho phép một
đội SA nâng cao kiến thức và kỹ năng cấp của nó. Hãy suy nghĩ về tài liệu như
RAID cho các nhân viên SA: Nó cung cấp cho bạn khả năng dự phòng trong nhóm. Một số SAs sợ
tài liệu đó sẽ làm cho họ có thể thay thế nhiều hơn và do đó từ chối
tài liệu những gì họ làm. Kết quả là, họ thường cảm thấy cuối cùng bị mắc kẹt, bị dồn ép, và không thể rời khỏi vị trí của họ. Họ nhận được nhấn mạnh và, trớ trêu thay,
bỏ ra khỏi thất vọng. Sự thật là, vì nó đồng thời giữ lại
và chia sẻ kiến thức, tài liệu cho phép một tổ chức thúc đẩy
mọi người từ bên trong.
Chương này cung cấp lời khuyên về làm thế nào để tạo ra tài liệu, làm thế nào để
lưu trữ nó và làm cho nó có sẵn, và làm thế nào để quản lý kho lớn hơn và lớn hơn . Chúng tôi nhấn mạnh các kỹ thuật để làm cho nó dễ dàng để tạo ra tài liệu của
241
242 Chương 9 Tài liệu
giảm các rào cản, thực tế và tinh thần, đó ngăn chặn những người duy trì
tài liệu.
9.1 Khái niệm cơ bản
Các vấn đề cơ bản liên quan đến việc có một số cách dễ dàng để tạo ra tài liệu, lưu trữ nó
để nó dễ dàng sử dụng, và làm cho nó có sẵn cho tất cả những người có thể cần nó.
9.1.1 gì vào tài liệu
Những điều đó là 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 phrasecomplicated hoặc unpleasantto 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, cái gì, andhow.Create 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.Title: 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.What: 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.How:The 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 vào awhy, 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 mới băng).
"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 UNIXenvironments đồ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
UNIXscriptcommand chụp toàn bộ phiên vào một tập tin.
Các UNIXcommandhistorylists 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 ofscriptandhistoryis 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. Thehistorycommand 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
giữ, nơi mọi thứ đang có, giải thích làm thế nào để làm điều đó, và làm cho thông tin hữu ích có sẵn cho khách hàng. Nói chung, tài liệu SAs không thích bằng văn bản:
Có hầu như không đủ thời gian để làm công việc; tại sao viết tài liệu, quá?
Lý do là tài liệu giúp bằng nhiều cách, và một thiếu tài liệu khả năng đau SAs 'để làm một công việc tốt.
Nó có thể được khó khăn để quyết định những gì đến tài liệu. Chúng tôi đề nghị là
ích kỷ: Sử dụng các tài liệu như một công cụ để làm cho công việc của bạn dễ dàng hơn. Sản helpdesk
ngập với những câu hỏi tương tự hơn và hơn? Cung cấp tài liệu
để khách hàng có thể tự giúp mình. Có những công việc mà bạn không thích làm gì?
Tài liệu chúng vì vậy nó là dễ dàng hơn để đại biểu họ hay để có một cơ sở SA đưa họ
hơn. Bạn có cảm thấy khó khăn để thư giãn trong khi đi nghỉ? Bạn bỏ qua những kỳ nghỉ
hoàn toàn? Tài liệu về quy trình mà chỉ có bạn có thể làm. Bạn dành cả ngày
sửa chữa những sai lầm mà có thể đã được ngăn chặn? Duy trì danh sách kiểm tra và gợi ý
tờ để cải thiện khả năng lặp lại.
Tài liệu là một cách để tạo ra một bộ nhớ thể chế cho phép một
đội SA nâng cao kiến thức và kỹ năng cấp của nó. Hãy suy nghĩ về tài liệu như
RAID cho các nhân viên SA: Nó cung cấp cho bạn khả năng dự phòng trong nhóm. Một số SAs sợ
tài liệu đó sẽ làm cho họ có thể thay thế nhiều hơn và do đó từ chối
tài liệu những gì họ làm. Kết quả là, họ thường cảm thấy cuối cùng bị mắc kẹt, bị dồn ép, và không thể rời khỏi vị trí của họ. Họ nhận được nhấn mạnh và, trớ trêu thay,
bỏ ra khỏi thất vọng. Sự thật là, vì nó đồng thời giữ lại
và chia sẻ kiến thức, tài liệu cho phép một tổ chức thúc đẩy
mọi người từ bên trong.
Chương này cung cấp lời khuyên về làm thế nào để tạo ra tài liệu, làm thế nào để
lưu trữ nó và làm cho nó có sẵn, và làm thế nào để quản lý kho lớn hơn và lớn hơn . Chúng tôi nhấn mạnh các kỹ thuật để làm cho nó dễ dàng để tạo ra tài liệu của
241
242 Chương 9 Tài liệu
giảm các rào cản, thực tế và tinh thần, đó ngăn chặn những người duy trì
tài liệu.
9.1 Khái niệm cơ bản
Các vấn đề cơ bản liên quan đến việc có một số cách dễ dàng để tạo ra tài liệu, lưu trữ nó
để nó dễ dàng sử dụng, và làm cho nó có sẵn cho tất cả những người có thể cần nó.
9.1.1 gì vào tài liệu
Những điều đó là 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 phrasecomplicated hoặc unpleasantto 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, cái gì, andhow.Create 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.Title: 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.What: 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.How:The 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 vào awhy, 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 mới băng).
"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 UNIXenvironments đồ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
UNIXscriptcommand chụp toàn bộ phiên vào một tập tin.
Các UNIXcommandhistorylists 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 ofscriptandhistoryis 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. Thehistorycommand 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
đ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ữ.
- THIẾT LẬP THÔNG SỐ
- don't let small minds convince you that
- Cử động mông
- which of them do you like ?which three a
- Chỉ tiêu này nói lên tổng vốn huy động c
- i wuant not talking about that
- gia đinh vui vè, bên nhau
- Him
- hai ngày trước tôi đã đặt một bữa tiệc ở
- CHANGE
- bạn ở đâu vậy ?
- excuse
- học có thành công
- khong hieu
- you love me
- họ là người giữ lửa cho gia đình lúc nào
- học mới có thành công
- instructor
- на электростанции
- If you have to reinstall other rom wifi
- projest manager
- đã lâu rồi gia đinh chúng tôi không đi c
- Omnivores
- projest manager
