P*tain de doc !

[Gofromiel]

Gofromiel

#2309

Ske c’est pénible d’écrire la doc !! Même si j’essaie en français j’ai du mal. Peut-être que je manque de recul par rapport à ce que je fais. J’ai du mal à trouver des formules simples pour expliquer mes idées.

D’ailleurs c’est drôle, je sais pas si ça vous le fait, mais j’ai tellement l’habitude de lire et d’écrire de l’Anglais que lorsque je réfléchis ça me vient dans la douce langue de Shakespear.

Pitet que j’ai développé une seconde zone du langage dans mon cerveau qui ne sert qu’à la documentation informatique En même temps elle doit pas être très développée

[anonyme]

anonyme

#45668

Salut Gofromiel, si tu veux un coup de main je serais heureux de t’aider

[corto]

corto

#45669

En général, on se met à penser et à rêver dans une langue quand on est dans le pays, bien imprégné après quelques temps. Si tu es dans l’anglais tous les jours, ça doit arriver aussi, tu n’as pas à t’inquiéter !

Pour ce qui est de la rédaction, parfois, effectivement ça coince. Je dois terminer un article pour aMiGa=PoWeR et j’ai le même problème. C’est pénible quand tu tournes en rond et tu commences à t’inquiéter de ce que pourra en comprendre le lecteur dans toute cette confusion … Je n’ai pas de méthode : soit insister et apporter des retouches et ça finit par plaire un peu plus, soit couper des parties, se reposer la question de ce qu’on veut dire et s’y remettre.

Courage !

/me qui retourne à son article confus …

[Lynx]

Lynx

#45670

D’ailleurs c’est drôle, je sais pas si ça vous le fait, mais j’ai tellement l’habitude de lire et d’écrire de l’Anglais que lorsque je réfléchis ça me vient dans la douce langue de Shakespeare.

Pire que ça. Moi – et j’étais pas le seul gars de l’IUT dans ce cas – dans certaines circonstances où on ne peut pas connaître la langue utilisée immédiatement – nom de variable par exemple – , je peux même pas imaginer que ce soit en français.

Par exemple, on faisait un prog de jeu de cartes, fallait compléter le code des fonctions, et là je vois une fonction qui s’appelle “main”. “Comment ça, “main”? C’est pas la fonction principale…ah, main comme une main à 5 doigts, d’accord… “

[bob1969]

bob1969

#45671

Faut dire que beaucoup de termes sont intraduisibles littérallement.

DUAL PLAYFIELD, VIEWPORT,HANDLER…font parti du patrimoine national

bob1969

[Gofromiel]

Gofromiel

#45672

C’est clair que ça ferait tout drôle d’utiliser du français pour programmer… surtout ça serait beaucoup plus long de taper tout ça ! Même mes commentaires personnel je les faits en Anglais

[Lanza]

Lanza

#45673

En plus Feelin’ doit être plein de crochets de rappel.

Personnellement je fais un mix du français et de l’anglais dans mes sources(identificateurs et commentaires), ce qui les rend un poil illisibles.

[Gofromiel]

Gofromiel

#45674

Je crois que c’est pareil pour tout le monde : la doc c’est la plaie !

[krabob]

krabob

#45675

Ske c’est pénible d’écrire la doc !!

Moi, j’avoue que j’adore ça !!! j’écris énormément de doc en anglais pour karate. J’ai d’ailleurs tendance a “écrire trop” en général, je fais une troisiéme passe les lendemains de rédaction pour enlever le superflu et clarifier.

J’ajoute que c’est indispensable au travail informatique.

J’ai du mal à trouver des formules simples pour expliquer mes idées.

Une méthode simple, utilisé par tout les dictionnaires:

Pour définir quelque chose, dire:

1. Ce que c’est. (présenter la forme)

2. A quoi ça sert. (les fonctionnalités.)

3. Eventuellement un exemple.

4. Eventuellement rentrer dans les détails. (=encyclopédie)

Ainsi: une table est un MEUBLE constitué d’un plateau et tenu par des pieds, et qui sert à poser des objets dessus.

En informatique, le danger est de trop utiliser un vocabulaire technique. Souvent les termes techniques actuels “a la mode”

sont remplaçable par des expressions plus abordable et plus intemporelle.

Dans tout les cas, relire en se mettant a la place du novice. Ca necessite de faire la pause et respirer un grand coup.

Pensez a leonard de vinci, dont “les docs techniques” étaient de véritables poësies.

[SoundSquare]

SoundSquare

#45676

ce qui est chiant avec mes docs c’est qu’elles sont longues à lacer, 14 trous c’est pas évident tous les matins

/me n’aime que les docs coquées

[krabob]

krabob

#45677

Et donc, je vous le refais:

SoundSquare (nom propre) öund[K[ [ae]rr

Utilisateur et modérateur récurrent d’amigaimpact, il sert à modérer, sortir des vannes et parler musique.

exemple:

ce qui est chiant avec mes docs c’est qu’elles sont longues à lacer (SoundSquare)

[M_o_Illusion]

M_o_Illusion

#45678

Lol bien vu krabob ^^

[SoundSquare]

SoundSquare

#45679

ça y est je suis une légende !

je suis plus modo btw.

[Gofromiel]

Gofromiel

#45680

Merci du conseil krabob ! Mon problème majeur c’est que je suis trop dans ce que je fais. Du coup j’ai absolument aucun recul et du coup tout me parait simple alors que non

Je vais faire une pause de toute façon, ce soir y’a l’île de la tentation Et l’épisode 5.10 de Six Feet Under que je brûle de voir ++

[WickedVinz]

WickedVinz

#45681

(Krabob)

Moi, j’avoue que j’adore ça !!! j’écris énormément de doc en anglais pour karate. J’ai d’ailleurs tendance a “écrire trop” en général, je fais une troisiéme passe les lendemains de rédaction pour enlever le superflu et clarifier.

J’ajoute que c’est indispensable au travail informatique.

Je me permets de signaler qu’elles sont excellentes les docs de Karaté !

(bon j’ai pas regarder le SDK pour faire ces propres FX mais les docs des effets ‘vendus’ avec sont très très bien !!)