|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
<sect1 id="manuals-production-identifying-goals">
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
1c9079 |
<title>Identifying Document Goals</title>
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
<para>
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
The first step in producing a documentation manual is to
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
clearly understand what you exactly need to document and why
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
you need to do so. The obvious answer to this question would
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
be to describe the basic ideas behind an implementation so it
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
can be useful once published. It is important that you find
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
out the reasons you need to do what you are doing and, also,
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
those helping you to retain the motivation to keep doing it in
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
the future. Otherwise, without such foundations, you'll surely
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
end up leaving the effort soon enough to make a lost cause
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
from your initial work.
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
</para>
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
1c9079 |
<para>
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
Before <citetitle>The CentOS Artwork Repository File
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
ff85fe |
System</citetitle> documentation manual would exist, there was
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
ff85fe |
an emerging need to understand what each directory inside the
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
ff85fe |
growing directory layout was for, how it could be used and
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
ff85fe |
each directory could be connected one another. At that moment,
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
ff85fe |
the directory layout was very unstable and explaining the
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
ff85fe |
whole idea behind it was not possible, there were too many
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
ff85fe |
changing concepts floating around which needed to be
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
ff85fe |
considered in the same changing way. So, to understand what
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
ff85fe |
was happening, the <citetitle>The CentOS Artwork Repository
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
ff85fe |
File System</citetitle> documentation manual was created.
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
1c9079 |
</para>
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
1c9079 |
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
1c9079 |
<para>
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
The <citetitle>The CentOS Artwork Repository File
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
System</citetitle> manual was conceived based on the idea of
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
ff85fe |
documenting each directory inside the repository individually
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
and, later, by considering all directory documentations
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
ff85fe |
altogether, it would be (hypothetically) possible to correct
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
ff85fe |
the whole idea through an improvement cycle that would
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
ff85fe |
consolidate the final idea we were trying to implement.
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
1c9079 |
</para>
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
1c9079 |
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
1c9079 |
<para>
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
9092ae |
Other documentation manuals can be based on reasons different
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
61b10c |
from those described above, however, no matter what those
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
ff85fe |
reasons are, it will be helpful to make yourself a clean idea
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
61b10c |
about what you are going to document exactly before putting
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
61b10c |
your hands on it.
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
1c9079 |
</para>
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
1c9079 |
|
|
![](https://seccdn.libravatar.org/avatar/6547be6a776b3f31e43b7f4b6dd82ebcede0f2d11be196e3a70e28760a760a3c?s=16&d=retro) |
1c9079 |
</sect1>
|