diff --git a/Manuals/Tcar-ug/Manuals/Production/identifying-goals.docbook b/Manuals/Tcar-ug/Manuals/Production/identifying-goals.docbook index 11b3d3d..7bbad54 100644 --- a/Manuals/Tcar-ug/Manuals/Production/identifying-goals.docbook +++ b/Manuals/Tcar-ug/Manuals/Production/identifying-goals.docbook @@ -1,32 +1,50 @@ - + + Identifying Document Goals + + + The first step in producing a documentation manual is to + clearly understand what you exactly need to document and why + you need to do so. The obvious answer to this question would + be to describe the basic ideas behind an implementation so it + can be useful once published. It is important that you find + out the reasons you need to do what you are doing and, also, + those helping you to retain the motivation to keep doing it in + the future. Otherwise, without such foundations, you'll surely + end up leaving the effort soon enough to make a lost cause + from your initial work. + + - Before TCAR-FS documentation manual - exist, there was an emerging need to understand what each - directory inside the growing repository layout was for, how - they could be used and how they could be connected one - another. At that moment the directory structure was very - unstable and explaining the whole idea behind it wouldn't be - possible, there were many changing concepts floating around - which needed to be considered in the same changing way. So, to - understand what was happening, the - TCAR-FS documentation manual appeared. + Before The CentOS Artwork Repository File + System documentation manual exist, there was an + emerging need to understand what each directory inside the + growing directory layout was for, how they could be used and + how they could be connected one another. At that moment, the + directory layout was very unstable and explaining the whole + idea behind it was not possible, there were too many changing + concepts floating around which needed to be considered in the + same changing way. So, to understand what was happening, the + The CentOS Artwork Repository File + System documentation manual was created. - The TCAR-FS manual let us to document - each directory inside the repository individually and, later, - by considering all directory documentations together, it would - be possible (hypothetically) to correct the whole idea through - an improvement cycle that would consolidate the final idea we - try to implement. + The The CentOS Artwork Repository File + System manual was conceived based on the idea of + individually documenting each directory inside the repository + and, later, by considering all directory documentations + together, it would be (hypothetically) possible to correct the + whole idea through an improvement cycle that would consolidate + the final idea we try to implement. - Other documentation manuals might be different from that - described above, however, it would be helpful to make yourself - a clean idea about what you are going to document exactly - before putting your hands on it. + Other documentation manuals can be based on reasons different + from those described above, however, no matter what those need + be, it will be helpful to make yourself a clean idea about + what you are going to document exactly before putting your + hands on it.