Requêtes de tutoriels

a marqué ce sujet comme résolu.
Auteur du sujet

Reprise du dernier message de la page précédente

Sujet du tutoriel : Doxygen

Présentation du tutoriel : Avoir une doc propre, c'est pas toujours évident. En plus d'apprendre à utiliser un logiciel qui donne des résultats absolument nickel, ce cours pourrait poser les bases de ce qui fait une bonne documentation et des habitudes à prendre en la matière.

Pourquoi un tel tutoriel ? : Pour des développeurs amateurs, la documentation de leurs projets passe souvent à la trappe, et c'est très dommage. Mettre l'accent sur l'importance de celle-ci et fournir un support de cours pour se "mettre le pied à l'étrier" ne peut être que profitable.

Cette réponse a aidé l’auteur du sujet

Sujet du tutoriel : Docker

Présentation du tutoriel : Un tutoriel progressif et clair qui nous permettrait de mettre en place un système de déployement basé sur les conteneurs.

Pourquoi un tel tutoriel ? : Parce qu'on parle de plus en plus de DevOps, d'intégration et de déployement continus, d'usines logicielles, etc, et Docker est une nouvelle solution qui présente des avantages face à la virtualisation.

Sujet du tutoriel : Doxygen

Présentation du tutoriel : Avoir une doc propre, c'est pas toujours évident. En plus d'apprendre à utiliser un logiciel qui donne des résultats absolument nickel, ce cours pourrait poser les bases de ce qui fait une bonne documentation et des habitudes à prendre en la matière.

Pourquoi un tel tutoriel ? : Pour des développeurs amateurs, la documentation de leurs projets passe souvent à la trappe, et c'est très dommage. Mettre l'accent sur l'importance de celle-ci et fournir un support de cours pour se "mettre le pied à l'étrier" ne peut être que profitable.

Richou D. Degenne

Je suis à 300% pour un tutoriel comme celui-ci ! Il est vrai que la documentation passe souvent à la trappe et pour cause on ne sait pas forcément comment faire pour que se soit organiser et clair … moi le premier :)

+0 -0

Je ne comprends pas trop l'intérêt de mettre un -1 à une proposition. Les +1 rendent compte de la popularité d'une suggestion, mais je ne vois pas pour quelle raison on serait contre un nouveau tutoriel, quel que soit le sujet.

La ponctuation

Pourquoi ? Parce qu'elle permet, il me semble, à la fois de donner du sens et du rythme au texte et que j'aimerais bien maîtriser cet outil, que j'utilise actuellement au pifomètre.

Vayel

Hello ! Je serais partant d’écrire un tuto sur la ponctuation, mais c’est plus au niveau typographique ? Je suis pas expert, mais je peux tenter de faire quelque chose. Mais ça risque d’être court, je vois pas comment on peut faire ça. Il y a des littéraires sur le site ?

Et une nouvelle proposition, une !

Sujet du tutoriel : la loi de l'offre et de la demande.

Aperçu : Ce tutoriel aborderait la loi de l'offre et de la demande d'une manière particulièrement complète. Il commencerait par aborder la loi de manière intuitive, avant d'en montrer la formulation mathématique, avec ses hypothèses, sa démonstration, et tout ce qui s'en suit. Par la suite, il sera fait état des limites de cette loi, notamment dans les axiomes utilisés pour la démontrer, ainsi que des biens qui ne respectent pas cette loi.

Pourquoi un tel tutoriel : parce qu'il faut bien se défendre contre ces pourritures de néolibéraux disciples du marché… Ou quelque chose dans le genre, mais en moins gauchiste…

Mewtow

Moi j’aime bien la version gauchiste :p

D’ailleurs, pourquoi pas des tutos pour apprendre des langues ? Faut se trouver une méthodo sympathique, personnellement, j’ai du mal avec ce qu’on trouve sur le « marché ». Si on a un cadre, une base sur lequel se baser pour écrire les cours, ça serait bien ! (Genre : apprenez l’espéranto, le Latin, le Globish, le patois…)

La tero estas nur unu lando | Géographe de service | Cliquez 👍 pour dire merci

+0 -0

Hello ! Je serais partant d’écrire un tuto sur la ponctuation, mais c’est plus au niveau typographique ? Je suis pas expert, mais je peux tenter de faire quelque chose. Mais ça risque d’être court, je vois pas comment on peut faire ça. Il y a des littéraires sur le site ?

Oui, a priori, un tuto sur la typographie en général serait plus adapté (même dans les références les plus complètes, le chapitre sur la ponctuation prend difficilement plus de 2 pages A4), mais j'avoue que je ne saurais pas comment faire plus qu'une compilation des 3-4 principales sources de référence sur le sujet…

D’ailleurs, pourquoi pas des tutos pour apprendre des langues ? Faut se trouver une méthodo sympathique, personnellement, j’ai du mal avec ce qu’on trouve sur le « marché ». Si on a un cadre, une base sur lequel se baser pour écrire les cours, ça serait bien ! (Genre : apprenez l’espéranto, le Latin, le Globish, le patois…)

Le sujet a été pas mal discuté déjà. ^^

#JeSuisGrimur #OnVautMieuxQueÇa

+0 -0

Je dois encore réfléchir, le temps me manque, mais si je ne suis pas seul à le faire, je veux bien :-)

qwerty

Un conseil (valable pour tous les potentiels rédacteurs qui hésitent) : lancez-vous.

Le problème c'est que peu osent se lancer tout seul, du coup ils ne se lanceront jamais.
Crée un tuto en brouillon, mets quelques phrases… dès fois, quand tu auras de la motivation, rédige un plan, jette quelques phrases par-ci par là. Le plus dur, c'est de commencer une page blanche en se disant "j'ai pas beaucoup de temps là, je vais pas commencer quelque chose". Résultat : tu ne commences jamais.

Alors qu'en faisant comme ça, le jour où tu auras de la motivation, tu partiras déjà de quelque chose, même à l'état embryonnaire. Et au bout d'un an, deux ans, voire plus on s'en fiche, ben tu auras quelque chose à publier :)

J'ai par exemple 8 tutos en brouillon, j'y touche de temps en temps par ci par là (ou pas d'ailleurs, mais je sais que je partirais pas de zéro si je m'y remets). Et plus le tuto avance, plus j'ai de la motivation pour le continuer.

Auteur du sujet

Allez, je prends les devants ! Qwerty, je te mets rédacteur, et j'invite les éventuels co-rédacteurs à se manifester parce que j'ai[^seul] très envie de voir ce cours.

Je suis le premier à râler quand je vois quelqu'un faire une faute de typo et avoir une ressource vers laquelle rediriger les hérétiques serait super, sans compter la masse de choses que je suis sûr d'ignorer à ce sujet !

Très très bonne idée Doxygen.

Nombre de fois où je vois les groupes inexploités ou l'utilisation de mots clés qui ne servent à rien là où ils le sont (\class, \function à côté de la déclaration commentée), alors que des hypers importants ne sont jamais utilisés (\pre, & cie). Le pire étant ceux qui tapent des commentaires qu'ils croient être au format Doxygen sans avoir jamais essayé de générer la doc pour voir à quoi ça ressemble où qu'elles erreurs étaient levées.

+1 -0

Le pire étant ceux qui tapent des commentaires qu'ils croient être au format Doxygen sans avoir jamais essayé de générer la doc pour voir à quoi ça ressemble où qu'elles erreurs étaient levées.

lmghs

D'un autre côté si la doc n'est pas générée, peu importe que la syntaxe ne soit pas respectée à la lettre… L'important reste quand même d'avoir un codé commenté correctement. :)

Développeur Symfony

+2 -0
Auteur du sujet

Oui et non. L'important est que l'utilisateur s'y retrouve. Naviguer dans les sources (si tant est que les sources soient fournies, ce qui est de toujours être le cas), c'est chiant sans les liens, les diagrammes et la jolie présentation en HTML ou LaTeX.

Soit on fait une doc, soit on en fait pas. :P

Je n'ai jamais généré ma doc (sur mes projets perso) jusqu'à présent, et j'arrive très bien à m'en sortir ; ainsi que le développeur qui code avec moi.

À mon sens, la génération de la doc n'est pas une étape obligatoire. Si tout est rangé là où il faut avec des noms adéquats, il suffit d'un bon IDE pour s'en sortir.

Développeur Symfony

+1 -0

Cette réponse a aidé l’auteur du sujet

Titre : Bien illustrer son texte

Quand ?

  • Schéma avant ou après les explications textuelles ?
  • Un gros à la fin, ou plein de petits ?
  • Où (aux points peu clairs ?) ?

Comment ?

  • Quel type (simple illustration, diagramme explicatif, etc.) ?
  • Quelle quantité d'informations ?

"Bienheureux celui qui sait rire de lui-même, il n’a pas fini de s’amuser." Joseph Folliet

+4 -0
Vous devez être connecté pour pouvoir poster un message.
Connexion

Pas encore inscrit ?

Créez un compte en une minute pour profiter pleinement de toutes les fonctionnalités de Zeste de Savoir. Ici, tout est gratuit et sans publicité.
Créer un compte