From 365d99469b2085b98cbbc7ef852a3d03b39c8aa6 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Sep 15 2011 05:19:14 +0000 Subject: Update `Manuals/Texinfo/production.docbook'. --- diff --git a/Manuals/Tcar-ug/Manuals/Texinfo/production.docbook b/Manuals/Tcar-ug/Manuals/Texinfo/production.docbook index 5ee2b70..e707b44 100644 --- a/Manuals/Tcar-ug/Manuals/Texinfo/production.docbook +++ b/Manuals/Tcar-ug/Manuals/Texinfo/production.docbook @@ -11,34 +11,39 @@ - Identifying Manual's Goals + Identifying Document Goals - The first step to create a documentation manual is to make - yourself an clean idea about what such manual will document - exactly. As the repository directory structure was built on, - there was an emerging need to understand what each directory - inside it 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 floting around which needed to be considered in the - same changing way. + Before the TCAR-FS exit, 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. - To understand what we were doing, it was decided to document - each directory inside the repository individually so as to - better understand the concepts it implements and how they - relate one another. Later, by putting 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 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 characteristics of other documentation manuals will surely + be different from those described above, however, it would be + helpful to make yourself an clean idea about what you are + going to document exactly before putting your hands on it. - Identifying Manual's Title + Identifying Document Title Once you've make yourself an clean idea of what the documentation manual is for and the needs behind, it is time @@ -68,7 +73,7 @@ - Identifying Manual's Structure + Identifying Document Structure Once both manual's title and manual's directory name have been defined, it is time to plan manual's structure through which @@ -193,7 +198,7 @@ - Implementing Manual's Structure + Implementing Document Structure To create a manual like the one described so far, you need to @@ -277,7 +282,7 @@ - Maintaining Manual's Structure + Maintaining Document Structure Most maintaining tasks related to documentation manuals written through texinfo documentation backend are standardized