From 8344333e39900a299121a7404ab98347574be0fe Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Aug 04 2011 19:52:10 +0000 Subject: Add `Tcar-ug/Manuals/Texinfo/production.docbook'. --- diff --git a/Manuals/Tcar-ug/Manuals/Texinfo/production.docbook b/Manuals/Tcar-ug/Manuals/Texinfo/production.docbook new file mode 100644 index 0000000..7eda1d6 --- /dev/null +++ b/Manuals/Tcar-ug/Manuals/Texinfo/production.docbook @@ -0,0 +1,64 @@ + + + Texinfo Document Production + + + The production of documentation manuals written in Texinfo + format is realized through the help functionality + of centos-art.sh script, as described in + . To illustrate the + production cycle, we'll describe it using the + Repository File System documentation manual as + reference. + + + + The first step before creating a documentation manual is to + make yourself an idea of what such manual intends to document. + The Repository File System emerged with the + need of understand what each directory inside &TCAR; is for, + how they can be used and how they connect one another as the + repository structure itself is built on. Explaining something + that is being conceived on its very first begining is a rather + difficult task. So, I decided to create documentation adapting + the same principales I followed to create functionalities + inside centos-art.sh script as a way to + understand what I was doing. This way, if programs should do + one thing well, each directory inside the repository should be + documented well in order to better understand what they do and + how they related one another. Later, summing them all would + let us, hypothetically, to correct the whole idea in a + repeatable cycle of improvement that would consolidate the + final idea we try to implement. + + + + Once you've make yourself an idea of what the documentation + manual is for, it is time to define the manual title and the + directory name where the manual will be sotred in. The manual + title describes, in few words, what the documentation manual + is about and can be changed later. The manual directory name + must be a word or several words separated by minus sign. As + convenction, as manual directory name would be useful to use + acronyms or abbreviations directly related to manual's title. + In our example, the documentation manual was initially titled + The CentOS Artwork Repository File System but + it was too long, so it was reduced to Repository File + System and the documentation directory name was set to + Tcar-fs. + + + + Once that both documentation manual title and directory name + have been defined, you can create the documentation manual + using the help functionality of + centos-art.sh script. In our example, the + command to execute would be the following: + + centos-art help tcar-fs: + + + ... + + +