Documentation templates and references




Does the GDP have documentation templates for the various types of docs
that accompany an application?  After reading sasha's suggestions and
questions, it seems like having all the GDP authors start with the same
template (which gives examples of these various standards decided on by
the GDP) would be a very good idea.  This would help authors get started
and would help maintain uniform documentation for GNOME applications.

If these templates already exist, where are they?

We could just say that the documentation for application X is good and can
be used as a template, but I don't think this would give us the
flexibility to provide a short, yet complete template illustrating all the
various markup tags and nomenclature (eg: GNOME, not Gnome) GDP authors
should use.

Perhaps we should have (1) a simple template with just the basic tags
which people use most, and then (2) a more complete GDP reference document
which lists the proper markups, nomenclature, etc.

Dan (muet)



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]