Proposal: Building Packages under Fedora

[Paul W. Frields]

On Mon, 2005-08-29 at 14:51 -0400, Ignacio Vazquez-Abrams wrote:
> On Wed, 2005-08-24 at 02:08 +0200, Peter Boy wrote:
> > Am Dienstag, den 23.08.2005, 00:30 -0400 schrieb Ignacio Vazquez-Abrams:
> > > notecase format (available in Fedora Extras).
> > valuable hint for me - didn't know it.
> > 
> > In Introduction you might add as a conclusion from your text: Even for
> > non programmers (but administrators / users )  one should make an rpm
> > package for all software, which the user will install from a tar ball
> > because no rpm is available or because he/she has to change its
> > behaviour. Because it is easier to administer the system.
> > 
> > Perhaps you should add a section after the Introduction with the titel
> > "goals and intended audience" of something like that. You should add
> > some information as
> > 
> > -  what can be learned here
> > -  what is different form generell rpm guides (as MaximumRPM)
> >    (perhaps: shorter / limited to essential? with features specific
> >    to the Fedora distribution?)
> > -  relation to the packaging guide of the extras project.
> 
> All excellent ideas. I will take them into consideration.

You might want to refer to the draft DocGuide notes on the wiki [1] for
recommended structures in a tutorial intro.  Peter is pretty much right
on the money; keep in mind that tutorials are procedure-oriented, so
they should define:

1. Purpose of the tutorial (as Peter says, what is the reader going to
learn from it?)
2. What you already need to know in order to understand the tutorial
(and hopefully pointers to that information)
3. A brief paragraph about any major concepts in the tutorial so you
don't have to interrupt the procedures later to explain it (example: If
you're writing a tutorial about using GnuPG, talk briefly about what
GnuPG is in this intro subsection)
4. Additional resources, like outside sites that are helpful or from
which you drew information
5. Acknowledgements - optional
6. Any draft or other notices needed

= = = = =
[1] http://fedoraproject.org/wiki/DocsProject/DocumentationGuide

-- 
Paul W. Frields, RHCE                          http://paul.frields.org/
  gpg fingerprint: 3DA6 A0AC 6D58 FEC4 0233  5906 ACDB C937 BD11 3717
 Fedora Documentation Project: http://fedora.redhat.com/projects/docs/
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
URL: <http://listman.redhat.com/archives/fedora-docs-list/attachments/20050829/42d26639/attachment.sig>