diff options
Diffstat (limited to 'zarb-ml/mageia-bugsquad/2011-September/000042.html')
| -rw-r--r-- | zarb-ml/mageia-bugsquad/2011-September/000042.html | 106 |
1 files changed, 106 insertions, 0 deletions
diff --git a/zarb-ml/mageia-bugsquad/2011-September/000042.html b/zarb-ml/mageia-bugsquad/2011-September/000042.html new file mode 100644 index 000000000..52369744f --- /dev/null +++ b/zarb-ml/mageia-bugsquad/2011-September/000042.html @@ -0,0 +1,106 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN"> +<HTML> + <HEAD> + <TITLE> [Mageia-bugsquad] Making the triage guide easier to read + </TITLE> + <LINK REL="Index" HREF="index.html" > + <LINK REL="made" HREF="mailto:mageia-bugsquad%40mageia.org?Subject=Re%3A%20%5BMageia-bugsquad%5D%20Making%20the%20triage%20guide%20easier%20to%20read&In-Reply-To=%3C4E85D3AF.6090202%40xs4all.nl%3E"> + <META NAME="robots" CONTENT="index,nofollow"> + <META http-equiv="Content-Type" content="text/html; charset=us-ascii"> + <LINK REL="Previous" HREF="000041.html"> + + </HEAD> + <BODY BGCOLOR="#ffffff"> + <H1>[Mageia-bugsquad] Making the triage guide easier to read</H1> + <B>Marja van Waes</B> + <A HREF="mailto:mageia-bugsquad%40mageia.org?Subject=Re%3A%20%5BMageia-bugsquad%5D%20Making%20the%20triage%20guide%20easier%20to%20read&In-Reply-To=%3C4E85D3AF.6090202%40xs4all.nl%3E" + TITLE="[Mageia-bugsquad] Making the triage guide easier to read">marja11 at xs4all.nl + </A><BR> + <I>Fri Sep 30 16:35:27 CEST 2011</I> + <P><UL> + <LI>Previous message: <A HREF="000041.html">[Mageia-bugsquad] Triage in yes/no steps +</A></li> + + <LI> <B>Messages sorted by:</B> + <a href="date.html#42">[ date ]</a> + <a href="thread.html#42">[ thread ]</a> + <a href="subject.html#42">[ subject ]</a> + <a href="author.html#42">[ author ]</a> + </LI> + </UL> + <HR> +<!--beginarticle--> +<PRE>Hi everyone, + +Andre999 gave me some good tips on how to make our Triage Guide easier +to read, without changing the content: + +**************************************************************************** + +After "OK, it is a duplicate, what should be done?" +(One could say "OK, it is a duplicate, what next?") +---- +"Since the bug is a duplicate of a previous report, you should set the +status of the bug to +<code>RESOLVED DUPLICATE</code> +with the appropriate bug number. +This will usually be the only action required. +If the fact that the bug is a duplicate ..." +---- + +- Any text that is to entered by the user should be between +<code>...</code>. +This will make it appear on a separate line, and always monospaced (so +as to be very readable), even if the other text is proportional. +(This is also used for computer code, hence the name.) + +- Frequently starting a new sentence on a new line makes it easier to +follow a somewhat complex line of thought. +- Using bullets a little more consistently should help as well. +- Point form is much clearer than amorphous paragraphs. + +But as I said above, the content seems very well thought out, it is only +the presentation that could use a little enhancement. + +Don't forget: documenting is more an art than a science, so don't be +afraid to use a little imagination in your presentation. And practice a +lot. + +BTW, in programming we learn what is called "prettyprint" in English. +Basically the above principles, for internal documentation of program code. +(Judging by external documentation, you can see that some programmers +learn a little better than others.:) ) + +************************************************************************************************************ + +The code tags don't need to be converted, in the new wiki they are the +same as in the old one. If no one opposes, I'd like to start replacing +the "strong" tags for words like "RESOLVED INVALID" "NEEDINFO" etc. with +code tags. + +Regards, +Marja + + + +</PRE> + +<!--endarticle--> + <HR> + <P><UL> + <!--threads--> + <LI>Previous message: <A HREF="000041.html">[Mageia-bugsquad] Triage in yes/no steps +</A></li> + + <LI> <B>Messages sorted by:</B> + <a href="date.html#42">[ date ]</a> + <a href="thread.html#42">[ thread ]</a> + <a href="subject.html#42">[ subject ]</a> + <a href="author.html#42">[ author ]</a> + </LI> + </UL> + +<hr> +<a href="https://www.mageia.org/mailman/listinfo/mageia-bugsquad">More information about the Mageia-bugsquad +mailing list</a><br> +</body></html> |