On Thu, Jan 06, 2005 at 08:30:21PM +0100, Sven Vermeulen wrote: > Okay, ppl are asking us what our 2005 goals are.
What I was generally thinking is:
- Pull in developers/contributors
* For the non-x86 installation instructions. Only a few developers are
frequently busy with the installation instructions and most knowledge is
situated at the x86 instructions.
* For the various projects that Gentoo is rich. There are quite a few
guides that are project-specific and some projects don't even have lots
of documentation (if they have any at all). We should be able to train
interested developers in GuideXML so they can focus on the documentation
of that particular project.
* For our own repository. New documents are always welcomed, but existing
documentation must also be maintained.
- Reintroduce status updates for all team members
Check who is part of the GDP and require a monthly status update.
It seems that there are many developers "part" of GDP but their last
action (wether commit, bug resolution or something else) happened a long
time ago.
- Improve documentation on GuideXML
The Coding Style for GuideXML should be moved elsewhere as it isn't
really part of GuideXML itself. Improve descriptions as to "why" instead
only "how" (e.g. "<abstract>" is used to blabla).
- "Writing Style" documentation
For instance the AP Style Guide. Such document would explain how Gentoo
writes its documentation (capitalised titles or not, coding style, ...).
This enforces a bit more consistency across all documents.
- Define when documentation should be in [doc] or in the project-specific
space.
This of course needs to be discussed with the various projects (probably
in gentoo-dev@). We will need to list the pro/cons clearly before
attempting to create a definition/policy.
- Audit the existing documentation
Verify if documentation is still valid, if no new way of handling things
improves the situation, wether there are spelling mistakes, ...
- More USE-case documentation
Documents such as the "Virtual Mailhosting Guide" are greatly
appreciated because they combine several existing projects in one.
Writing documentation on a single subject also happens at the
project-pages themselves (such as "CUPS", "Nano", "Vim", ...) but
combining projects (such as "MySQL + Postfix + ...") is rarely
documented.
That's what I had in mind.
Comments, feedback?
Sven Vermeulen
--
Documentation & PR project leader
The Gentoo Project <<< http://www.gentoo.org >>>
pgptQ8nZMlNAx.pgp
Description: PGP signature
