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