GuideStyle

MeatballWiki | RecentChanges | Random Page | Indices | Categories

Cette page a démarré sur le StyleGuide

Règles d'Or

: Ecrivez pour le lecteur, mais souvenez-vous que vous êtes aussi un lecteur ; ainsi, éditez le texte jusqu'à ce qu'il devienne utile tout aussi bien pour vous-même. Respectez les idées des autres de ce qui est utile. Parfois, ceci est mieux fait en créant simplement une nouvelle page, mais ce n'est pas une règle générale.

Pour les wikis d'équipes, la dernière ligne change vers ...

: Parfois ceci est mieux fait en créant simplement une nouvelle page pour prendre des notes, mais pas toujours.

: Si j'avais plus de temps, cette histoire aurait été plus courte.
: --Paraphrase d'une traduction de Blaise Pascal, souvent mal réattribuée à Mark Twain.

Le GuideStyle sera toujours incomplet parce qu'écrire bien est une science incomplète et que MeatballWiki ne fait pas nécessairement autorité sur l'écriture. Quelques-unes des idées sont spécifiques aux wikis. MeatballWiki est au moins une autorité pour l'écriture sur MeatballWiki. Les nouveaux contributeurs devraient tenir compte de ce que nous avons appris des manières dont ce médium affecte leurs styles d'écriture. A ce stade, voilà ce que nous avons appris.

Les ConventionsEpellation simplifient à la fois les vies des lecteurs et les tâches des auteurs. Alors que l'épellation peut sembler une question de style personnel, ceci doit être tempéré avec la patience de vos lecteurs.

Les AbréviationsSontInfernales parce que ce sont de mauvaises épellations sur demande. Elles provoquent des confusions parce que les lecteurs ressentent ensuite comme s'ils relevaient de leur responsabilité d'apprendre ce qui peut être considéré seulement comme de la paresse de la part de l'auteur.

EviterLesLiensSecondaires parce que ce sont des champs de mines pour la confusion.

La PagePeuProfonde qui ne vaut même pas le temps de cliquer dessus.

Le ContexteTemporel dans l'écriture nécessite une attention particulière parce que le temps est une chose amusante sur un wiki. Nous avons à la fois l'InstantWiki et les ModificationsRécentes pour y faire face.

Evitez le ProblèmeDuJargon en comprenant sa nature.

RépondezSurLaTotalitéDuBillet?. N'interrompez pas les autres.

Voir aussi StyleBonLien et Wiki:GoodStyle en anglais

D'autres styles

Nous décrivons occasionnellement d'autres styles d'écriture, bien que nous ne les recommandons pas nécessairement pour le MeatballWiki.

PointDeVueNeutre?, le style de WikiPedia, qui serait probablement mieux nommé "pas de point de vue."
EPrimeLanguage s'écrit sans utiliser le verbe To Be afin d'éliminer de fausses catégorisations et d'autres erreurs pouvant être présentées par ce verbe.
Le RoyalNous écrit sur un wiki de la bouche d'un leader agit comme une voie simple et démocratique pour décrire rapidement une politique sans dénigrer la capacité des membres de la communauté à la dissidence.

Règle du Pouce

Voici un petit jeu auquel je joue :

Ecrire, puis effacer et simplifier autant que possible. Utiliser des mots plus petits. Supprimer les mots qui n'ajoutent pas de valeur. Effacer les fenêtres d'habillage réthorique, la bonne rhétorique n'est pas séparée du message.

Quand vous êtes bon sur ces points, vous trouverez que votre sens du rythme s'améliorera et avec cela votre style rhétorique. La plupart des phrases sonnent bien quand elles sont croquantes mais avec du sens. Faites ainsi avec les noms de pages wiki.

Vous seriez étonné du temps que cela me prend d'écrire un beau billet de trois lignes. Parfois, vous pouvez me regarder éditer le même texte tant de fois dans une ligne. Cela demande des efforts, mais en vaut la peine parce que le texte résultant est propre et croquant... -- SunirShah

Trancher les pages

: Combien de temps est trop long avant de que cela ne mérite sa propre page ? -- SteveWhite?
: Tu ne sais jamais jusqu'à que cela soit tranché. -- AlexSchroeder
: Je vais faire quelques tests pour trouver des limites efficaces. C'est une des raisons pour laquelle j'expérimente les Tables des Matières et d'autres capacités useMod. -- HansWobbe

Quand une page devient trop longue, considérez de la retravailler et de déposer des sections de pages autonomes.

Types de Phrases

Les phrases sont classées selon leur structure :

Les phrases simples ont un sujet et un attribut. Soit le sujet ou l'attribut ou les deux peuvent être composés.
Les phrases composées ont au moins deux clauses indépendantes, chacune d'elle ayant sont propre sujet et attribut.
Les phrases complexes ont une ou plus de clauses dépendantes et une clause indépendante.
Les phrases composées complexes ont au moins deux clauses indépendantes (comme la phrase complexe).

Structure Préférée

Les phrases courtes tendent à avoir une construction simple. Ceci est une considération valable dans le marché international.

Evitez les phrases composées. Si nécessaire utilisez deux phrases séparées.

Approchez avec prudence les phrases complexes, avec leurs clauses subalternes, les locutions prépositives et des marqueurs potentiellement mal placés. Si cela fonctionne, les résultats sont géants. Si ce ne l'est pas, ce peut être dangereux.

Les fragments de phrases peuvent être utilisés dans des listes à puces et dans les tableaux mais ne devraient jamais apparaître dans le texte.

Personne, Humeur et Voix

Ecrivez le texte descriptif au présent, à la troisième personne, avec une humeur indicative et une voix active. En d'autres mots, écrivez comme si vous parliez à quelqu'un et utilisez des verbes d'action pour d'écrire les événements comme ils se déroulent.

Exemple: Le couplage de porte met les commutateurs hors tension de la TELECOMMANDE quand la porte est ouverte.

Et NON : Les commutateurs de TELECOMMANDE sont désactivés par le couplage de porte quand la porte est ouverte.

Ecrivez les textes de procedure au present, à la 2° personne, à l'impératif et avec une voix active.

Exemple: Forez les trous de support et boulonnez le coffret au mur...

NON: Un trou de support devrait être foré et le coffret boulonné au mur.

Paragraphes

Pensez le paragraphe comme la partie la plus grande de texte que le lecteur peut traiter en même temps. La taille d'un paragraphe, d'une ligne unique à quelques phrases ne compte pas autant que sa portée.

Pour être plus efficace, un paragraphe peut tenir tout entier de telle façon que toutes ses phrases appartiennent à chacune des autres. Un paragraphe doit aussi montrer une organisation délibérée, de telle sorte que le lecteur est guidé à travers, plutôt que d'être propulsé dans le texte. En conclusion, un paragraphe doit être complet, avec une unité qui autorise les lecteurs à regarder ailleurs après avoir fini le paragraphe et d'être capable de comprendre et de se souvenir ce qu'ils viennent de lire.

Fonction

Dans des domains différents de l'écriture technique, les fonctions des paragraphes varient avec le type d'écriture et avec la technique et l'habileté de l'auteur.

Pour le rédacteur technique, les paragraphes jouent généralement l'une des fonctions suivantes :

Définition (l'étendue d'une opération ou d'une procédure ou d'un document, etc.)
Description (l'équipement, les resolutions écrans, les réglages, calibrages, etc.)
Détails (nombre de parties, outils requis, caractéristiques du tube, etc.)
Direct (une opération, une procédure de service, les étapes d'une check-list, etc..)

Quand vous demandez ce que fait un paragraphe, la réponse pourrait être une de ces quatre fonctions. Si un paragraphe joue deux ou plus de fonctions, il est trop gros, complexe et non focalisé. Un paragraphe, souvenez-vous, doit montrer une organisation délibérée. Le fait de regrouper simplement des phrases ensemble dans un bloc n'est pas suffisant pour créer un paragraphe.

Structure

Le paragraphe dans l'écriture technique a deux parties ' le foyer et l'appui.

Le foyer, aussi appelé la phrase-clé est la promesse du paragraphe. Le foyer dit ce dont parle le paragraphe et fournit la base de ce que traite le reste du paragraphe. Il est plus souvent une phrase, même s'il peut être composé d'un fragment de phrase, comme l'en-tête vers une liste. Le foyer est la première phrase dans le paragraphe. Les paragraphes qui démarrent avec une instruction de référence, par exemple, "Voir Figure 3.2", auront le foyer dans la deuxième phrase.

L'appui est le corps du paragraphe et contient les détails, étapes, arguments, faits et exemples ?

ModeDocument vs. Mode Fil

Assurez-vous de bien connaître la difference entre le ModeDocument et le ModeFil. Parfois vous trouvez les deux sur une page. Une idée en haut de la page, un trait horizontal puis une discussion. Si la discussion grandit et grandit, la page est tranchée en deux : la première page tient l'idée, la seconde supporte la discussion.

Ainsi, ne commencez pas un fil de discussion au milieu d'une élaboration. Citez quelques mots et discutez en bas de la page ' ou retravaillez l'idée. Ne transformez pas les documents en fils de discussion.

Si la discussion meurt, retravaillez-là. Peut-être que la discussion en elle-même a de la valeur, alors conservez-là sur une autre page. Souvent les discussions peuvent être résumées quand elles sont terminées.

Que diriez-vous de donner aux utilisateurs quelques clés explicites sur la structure désirée de la page ? Comme une note du type 'Cette page est en mode document' pour le début ? Avec des liens attachés pour une description du schéma. Bien sûr cela peut s'appliquer tout aussi bien pour d'autre règles. -- ZbigniewLukasiak

La Discussion a de la Valeur

Il y a une emphase forte sur le ModeDocument anonyme de ce site parce que ce site est essentiellement un dépôt. Cependant, après de longs arguments, les gens disent parfois des choses intéressantes. Pas intéressantes de façon abstraites, mais humainement intéressantes. Ce peuvent être des témoignages personnels comme des anecdotes ou des avis. Ou ce peut être une rhétorique particulièrement liquide. Dans ces cas, il est justifiable de préserver des citations signées parce que c'est amusant. Ceci identifie également la contribution de façon positive.

Une méthode pour retoucher est la réduction du mode fil de discussion à son essence nue. Une conversation trop vague est remplie de mots insignifiants, ou de demi-idées explorées ailleurs en détail. Considérez alors de dépouiller la conversation vers une extrême simplicité, mais laissez-la sous forme de conversation.

Ceci laisse de la place pour des idées et des objections inachevées. Il est également légitime de laisser derrière l'argument incorrect. Ceci fournira au lecteur un dialogue de telle façon qu'il puisse suivre ces travaux à travers l'argument. Combiné avec la réduction vue ci-dessus, c'est une technique puissante pour emmener un lecteur sur un concept difficile. Les erreurs sont aussi des expériences.

En réduisant le mode fil, maquillez les noms comme Alice et Bob, ou utilisez l'anonymat déclenché : employez alternativement l'italique et le texte normal ou le texte indenté et normal.

Signature des Contributions

Quand vous signez une contribution dans un fil, utilisez votre nom. --AlexSchroeder

Quand vous ajoutez (votre contribution) à une page sans participer à une discussion, prenez en considération le fait de ne pas signer votre contribution ou d'ajouter votre signature à une liste de contributeurs. Ceci encourage le remaniement.

Au moment d'écrire un contenu anonyme, n'écrivez pas à la première personne. Inversement, au moment d'écrire un testimonial, signez avec votre nom. Ecrire souvent à la première personne n'est pas un testimonial. Dans ce cas, écrivez le formellement (c.a.d. pas à la première personne).

Initiales

Evitez d'utiliser vos initiales pour signer vos contributions. Les initiales ne sont pas claires, impersonnelles, et rendent obscures la pratique de l'usage du VraiNom (UtiliserUnVraiNom), et gênent les futurs efforts de remaniement. Signez soit avec votre nom ou écrivez anonymement.

Dans certains cas les initiales peuvent être acceptables afin de maintenir le contexte dans un fil de discussion, mais seulement quand vous vous attendez à ce que votre contribution disparaisse ou soit remaniée très bientôt. Considérez d'utiliser d'autres moyens pour séparer des voix distinctes comme l'italique ou l'indentation.

Contexte du Fil de Discussion

Le contexte du fil de discussion est souvent essentiel, même si l'auteur véritable ne l'est pas. Laisser des commentaires non signés rend le fil difficile à suivre parce ce chaque affirmation doit vivre sans le contexte des affirmations précédentes. Signez vos contributions avec des initiales si nécessaire pour maintenir le contexte du fil, à moins que vous ne vouliez vraiment que votre contribution soit marquée avec votre nom (c.a.d., ne pas être anonyme). Pensez au fait que vos initiales agissent comme des marqueurs de voix, mais pas d'ego. Voir AnonymatVsPseudonymat.

Il serait bien si c'est votre première contribution dans le fil qu'elle soit signée avec votre NomUtilisateur complet, et puis ensuite des initiales comme exigées ' c'est similaire à la bonne règle de style pour la première utilisation d'acronymes.

De ce fait, au moment de retravailler, traitez le festin de commentaires comme plus anonyme que des commentaires signés, exception faite du moment où le bon sens prévaut.

Mais soyez prudent au moment de retravailler un BazarFils de discussion que vous ne zappiez pas le seul et unique exemple du NomUtilisateur d'un contributeur. Ce peut être difficile si l'entrée initiale d'un commentaire par un participant est d'une faible/basse pertinence. Une approche consiste à migrer le NomUtilisateur vers un autre commentaire, en remplaçant les initiales des contributeurs avec leurs noms d'utilisateurs pleins. La sélection d'une première contribution qui est aussi valable (par ex. peu susceptible d'être remaniée), mais qui figure également plus tôt dans le fil (afin d'éviter des initiales apparaissant avant le nom utilisateur), est ce qui rend le retravail plus dur. Placez plutôt une liste de contributeurs.

Convention d'écriture

Considérez que la convention de signature est la même convention que vous utilisez au moment de citer les autres.

: Time flies like an arrow. Fruit flies like a banana. -- Groucho Marx

Si vous considérez une page wiki comme une page normale (comme du papier), alors les conventions d'écriture sont essentiellement les mêmes que celles utilisées pour mettre en page une page dans un livre. En cas de doute, écrivez comme vous le faites sur un papier formel. Plus vous essayez d'écrire comme ça, plus le site s'élèvera vers quelque chose proche d'une moyenne de rendu vraiment lisible.

Une grosse modification ou plein de petites ?

Au moment d'effectuer de nombreuses éditions sur une page, on devrait essayer de sauvegarder la page seulement une fois (pour minimiser l'impact des ModificationsRécentes pour ceux qui utilisent &all=1), où on devrait sauvegarder la page de nombreuses fois de telle façon que les différentes éditions peuvent être plus facilement mieux comprises en regardant les diffs ?

Si vous faites une chose à la fois, il y a moins de chance que vous fassiez une faute. Pour aller plus loin, les personnes utilisent rarement use all=1.

Dossiers Voir Aussi

Vous verrez souvent des LienHorsDeLaLigne flottant autour des "Voir aussi" comprenant des "mettez en perspective" ou "comparez" ou "imaginez" ou une phraséologie similaire en français. Parce que ce sont des liens utiles pour accrocher les pages ensemble et ils sont un style acceptable dans de nombreux cas, il est mieux de classer le voir aussi à l'intérieur du corps principal du texte comme un lien en ligne, même aussi mollement qu'avec une référence en contexte (cf.), mais beaucoup mieux comme Wiki:WikiGrammar. Ceci peut exiger d'écrire plus de texte. Bien ! C'est plus clair de cette façon que de simplement fournir un lien sans la relation attendue expliquée. Après tout, un voir aussi est simplement une note sur un point de forme. Aussi si vous voyez un voir aussi et le suivez, tenez-vous prêt à revenir pour écrire votre impression de la relation.

En plus, les RétroLiens sont aussi des voir-aussi, mais bien plus cachés. Vous pouvez vouloir écrire à propos de leurs relations à la page en cours si vous pensez que c'est pertinent.

LangueFrançaise PageTranslation StyleGuide