diff options
Diffstat (limited to 'zarb-ml/mageia-discuss/20101007/002271.html')
| -rw-r--r-- | zarb-ml/mageia-discuss/20101007/002271.html | 145 |
1 files changed, 145 insertions, 0 deletions
diff --git a/zarb-ml/mageia-discuss/20101007/002271.html b/zarb-ml/mageia-discuss/20101007/002271.html new file mode 100644 index 000000000..9e718e21f --- /dev/null +++ b/zarb-ml/mageia-discuss/20101007/002271.html @@ -0,0 +1,145 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN"> +<HTML> + <HEAD> + <TITLE> [Mageia-discuss] [Doc Team] Proposal, questions ? + </TITLE> + <LINK REL="Index" HREF="index.html" > + <LINK REL="made" HREF="mailto:mageia-discuss%40mageia.org?Subject=Re%3A%20%5BMageia-discuss%5D%20%5BDoc%20Team%5D%20Proposal%2C%20questions%20%3F&In-Reply-To=%3C20101008020103.6dbc3097.john%40neodoc.biz%3E"> + <META NAME="robots" CONTENT="index,nofollow"> + <META http-equiv="Content-Type" content="text/html; charset=us-ascii"> + <LINK REL="Previous" HREF="002267.html"> + <LINK REL="Next" HREF="002268.html"> + </HEAD> + <BODY BGCOLOR="#ffffff"> + <H1>[Mageia-discuss] [Doc Team] Proposal, questions ?</H1> + <B>John</B> + <A HREF="mailto:mageia-discuss%40mageia.org?Subject=Re%3A%20%5BMageia-discuss%5D%20%5BDoc%20Team%5D%20Proposal%2C%20questions%20%3F&In-Reply-To=%3C20101008020103.6dbc3097.john%40neodoc.biz%3E" + TITLE="[Mageia-discuss] [Doc Team] Proposal, questions ?">john at neodoc.biz + </A><BR> + <I>Thu Oct 7 15:01:03 CEST 2010</I> + <P><UL> + <LI>Previous message: <A HREF="002267.html">[Mageia-discuss] News about the forum +</A></li> + <LI>Next message: <A HREF="002268.html">[Mageia-discuss] Wish List +</A></li> + <LI> <B>Messages sorted by:</B> + <a href="date.html#2271">[ date ]</a> + <a href="thread.html#2271">[ thread ]</a> + <a href="subject.html#2271">[ subject ]</a> + <a href="author.html#2271">[ author ]</a> + </LI> + </UL> + <HR> +<!--beginarticle--> +<PRE>On Wed, 6 Oct 2010 07:55:31 +0200 +yvan munoz wrote: + +><i> Please first excuse my english level (and sometimes usage of automatic +</I>><i> translation) +</I>><i> I have some reflexions and questions i think it could be interesting to +</I>><i> share here : +</I>><i> +</I>><i> Doc Team. +</I>><i> +</I>><i> _ base : that the documentary team has previously conducted +</I>><i> _ base : operation for common tools for this job +</I>><i> +</I>><i> _ objective : make participation easy +</I>><i> _ objective : produce quality docs for readers +</I>><i> +</I>><i> _ question : could we mix the usage of wiki and edition ? ;-) +</I>><i> _ proposition : reserve wiki for contributors works, simply by have a +</I>><i> large banner at the top of wiki welcome page (docs.mageia.org ? or +</I>><i> whereever). Banner invite to download latest doc compil. +</I>><i> +</I>><i> _ effect : no invitation to read wiki. Wiki is ever a working place (as +</I>><i> cauldron is dev sys) +</I>><i> _ effect : Readers and users have ever a validated and finalised +</I>><i> documentation +</I>><i> _ effect : preserve 'works-ever' wiki and prevent any 'never-finished' +</I>><i> impression for docs readers +</I>><i> _ effect : make people want to participate by producing a good doc final +</I>><i> quality +</I>><i> +</I>><i> No revolution, no new tool, no great idea (sorry :p), just a little orga +</I>><i> adjusment to change perception of readers on our doc. +</I>><i> Additonnals : produce in well know format, standard, with easy scanning +</I>><i> and indexing for desktop tools (as strigi / nepomuk) +</I>><i> +</I>><i> Resume in two sentences : +</I>><i> Wiki is for workers. Final doc is for readers, and could include common +</I>><i> texts (as releases notes, issues and wiki doc) +</I>><i> Mix wiki usage for edition objective to have separation between places : +</I>><i> works and reads. +</I>><i> +</I>><i> Regards +</I> +Historically, in the Mandrake/Mandriva context, documentation was +basically a two-part scheme. Those parts were: + +Man pages: Mostly the responsibility of the developers of the applications. + +Printed Manuals: Primarily for inclusion in boxed sets for each release, +but included in the distributed media as HTML and PDF files. The manuals +were coordinated by company employees and an international team of writers, +translators, technical and language proofreaders. + +Later, (about 2006 I think) some material (in the form of HowTos) began to +be published as webpages but was not dealt with by the DocTeam itself. + +The source material was stored in CVS/SVN repositories on the company +servers using a custom-built application called Borges to manage +synchronisation between each module it's screenshots and the various +language teams. + +All base material was written using US English and then translated to each +of the other reference languages. For example the 2008.1 release had 14 +'official' languages, each language being coordinated by it's own team +leader. + +In my opinion, this scheme worked very well, even if there were a few +'hassles' close to release when some functions in some programs didn't +always work as described :-) (Blame the devs for changing their minds!) + +Take a look here to see how the project was organised for 2007.1: + +<A HREF="http://wiki.mandriva.com/en/Documentation_Project_Status">http://wiki.mandriva.com/en/Documentation_Project_Status</A> + +At this time I doubt that we would be producing hardcopy manuals but +whatever documentation we produce should be of the same or better quality +as those we produced then. That is; we should aim to use quality writing +and screenshots and regardless of anything else what is produced it should +be in a print-ready form for ease of reference. + +Thoughts? + +John NZ +-------------- next part -------------- +A non-text attachment was scrubbed... +Name: not available +Type: application/pgp-signature +Size: 197 bytes +Desc: not available +URL: </pipermail/mageia-discuss/attachments/20101008/404eab5a/attachment-0001.asc> +</PRE> + +<!--endarticle--> + <HR> + <P><UL> + <!--threads--> + <LI>Previous message: <A HREF="002267.html">[Mageia-discuss] News about the forum +</A></li> + <LI>Next message: <A HREF="002268.html">[Mageia-discuss] Wish List +</A></li> + <LI> <B>Messages sorted by:</B> + <a href="date.html#2271">[ date ]</a> + <a href="thread.html#2271">[ thread ]</a> + <a href="subject.html#2271">[ subject ]</a> + <a href="author.html#2271">[ author ]</a> + </LI> + </UL> + +<hr> +<a href="https://www.mageia.org/mailman/listinfo/mageia-discuss">More information about the Mageia-discuss +mailing list</a><br> +</body></html> |