Blame Documentation/Models/Docbook/Tcar-ug/Manuals/Production/identifying-goals.docbook

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