Documentation globale en ligne ?

Bonjour à tous,

Je voudrais vous présenter une idée de projet que je rumine depuis un certain temps : une documentation globale en ligne.
'documentation' n'a pas de vocation pédogogique : il s'agit simplement d'un manuel, exactement à la manière des pages du man sous Linux, ou comme ça ou encore ça.
'global' signifiant que cela concerne tous les langages de programmation, contrairement à la doc PHP ou Python.

Ce projet se présenterais sous forme de wiki, comportant quelques restrictions pour la protection des pages complètes pour la fiabilité du contenu (je ne m'étale pas là-dessus, j'ai quelques idées pour un système qui marche).

Ce site aurait (à mon sens) une raison d'être parce que tout le monde n'a pas man et que man n'est pas complet, et offrerait par rapport aux documentations en ligne spécifiques aux langages l'avantange de l'uniformisation, de l'ergonomie et de la simplicité extrème (design dépouillé, etc.) ; aucune frioriture, pleinement orienté productivité dans la recherche (pouvant se faire en spécifiant un langage ou non).
De plus, des langages comme C n'ont de documentation officielle.

Si je vous présente ce projet (à l'avancement technique quasi-nul), c'est pour avoir votre avis sur l'utilité d'un tel projet.
Personnellement, le site tel que je l'imagine me serait souvent utile, mais qu'en est-il de vous ?

J'aurais du mal à mener à bout ce projet avec ma seule motivation sans avoir d'avis positifs (et bien sûr, si ils sont globalement négatifs, j'aurais au moins des bonnes raisons de ne pas me fatiguer ).

Concernant sa réalisation, je devrais pouvoir m'en occuper seul et j'ai déjà une petite idée sur le ndd. Tout ce dont j'aurais grandement besoin serait de contributeurs... si ce projet arrive à terme

Merci d'avance pour vos avis !

Salut je pense que c'est une bonne idée (même très bonne), ca permettrai d'avoir une Doc "commune", ce qui éviterai pas mal de recherche.
Je te soutiens moralement par contre j'ai vraiment plus le temps de m'occuper d'un site ou même de le concevoir.
++
Bonne chance pour ton projet.

Je trouve que c'est vraiment une excellente idée.
Ne perd rien de ton enthousiasme, j'espère que tu pourras mener ce projet à terme.

Je suis du même avis, c'est un très bon projet.
Si tu décides de le commencer, je te souhaite bonne chance

Bye.

Très bonne idée de projet. Il pourrait rejoindre celui de bluestorm qui avait pour idée de faire un wiki. Chacun pourrait contribuer à la documentation, à la manière de Wikipédia en fait.

J'aimerai bien t'aider mais je ne maîtrise pas le PHP autant que certains sur le site, donc je ne préfère pas être un poids dans ton projet.

Si tu termines cette documentation commune, j'en serai un utilisateur régulier. En effet, je consulte régulièrement la doc PHP, qui est très bien faite mais qui a un côté un peu barbare. Tout y est bien expliqué mais on nous balance ça comme une définition de dictionnaire, et c'est à nous de nous y retrouver. Maintenant que j'ai un peu d'expérience en PHP, je trouve la doc moins inaccessible qu'à mes débuts mais j'imagine la galère des Zér0s qui sortent du tuto de M@teo21 et qui essaient de piquer des infos par-ci par-là.

En clair, il faudrait rendre cette doc accessible autant aux débutants qu'aux confirmés, quel que soit le language en question. Après tout, on est sur le Site du Zér0 non ?


Sur ce, bon courage pour ton projet

Perso, je trouve que c'est une bonne idée. Mais cela ne me servirait à rien (ou presque).
Mais c'est vrai que des fois certains ont besoin de précisions ...

Quant au langage C, je signale que les drafts existent, même en anglais c'est du bon .

Duarna, vivent les docs dans toutes les langues !

Je m'étais déjà demandé si un tel site existait mais ce n'était pas le cas. Je trouve donc que c'est une très bonne idée et une très bonne initiative que tu as là. Cependant, je te souhaite bon courage si tu souhaites te lancer dans un tel projet.

Je ne saisis pas trop le but du projet, est-ce que ce wiki se veut être un condensé de toutes les docs existantes ?
Dans ce cas, pourquoi ne pas faire un micro-moteur de recherche qui envoie les mots-clés aux moteurs des sites officiels de php, mysql, etc. (sauf le C) ?
Ou alors ce serait pour présenter la programmation comme un outil pour résoudre un problème, indépendament du langage ?
Merci de m'éclairer

Question: est-ce que tu en resterais (pas vraiment le bon terme, mais tu m'as compris) au langages, ou tu voudrais pousser à certaines lib/methodes/techniques?

Merci à vous pour vos réponses !

Vinchz > je ne connais pas vraiment le projet à bluestorm.
Sinon le manuel ne sera pas censé nous apprendre le langage, mais bien sûr il tendra à être clair et simple (expliquer une notation particulière, donner des exemples simples et correctement expliqués). Et c'est là que le système wiki est vraiment efficace, parce que vous aurez le pouvoir à ce niveau là

Duarna > oui, des specs officielles existent pour le C, mais rien d'aussi simple et exploitable que php.net pour PHP par exemple, c'était ce que je voulais dire par là

Eldalion > par vraiment un condensé, mais simplement une documentation qui au lieu de se restreindre à un seul langage, les traîte tous. Et que des documentations officielles existent à la base, ou pas du tout. En tous cas ce n'est pas du tout "pour présenter la programmation comme un outil pour résoudre un problème, indépendament du langage".

Et en fait, j'ai déjà pensé à ce "micro-système de recherche", mais ça pose certains problèmes :
1/ beaucoup de langages ne sont pas traîtés (certains n'ont pas de doc officielle, d'autres ne possèdent pas de système de recherche simple de façon à faire une redirection automatique dans ce genre)
2/ impossibilité d'effectuer deux recherches l'une à la suite de l'autre
3/ ça fait bizarre de faire une recherche et de se retrouver directement sur un autre site, changer de site comme ça ça n'est pas "dans les règles"
4/ les docs officielles ne sont pas parfaites même si elles restent une référence, dans beaucoup de cas on peut envisager faire une meilleure page
5/ on serait dépendant de l'état des serveurs des divers sites

Si le site faisait juste redirection, il perdrait à peu près tout son intérêt, autant aller directement sur la doc du langage que l'on veut
Parce que l'intérêt majeur de ce site est justement la centralisation des pages de documentation, et un accès et une modification facile.

Seeme > c'est une des questions que je me suis posé à la base.
Dans l'état acutel des choses, je ne vois pas d'inconvénient majeur à ce que la documentation traîte aussi toutes les extensions du langage. Et d'ailleurs dans certains cas difficile de représenter la "base" des "extensions".

Le seul "gros" problème que cela pourrait poser ça serait d'avoir un fouilli car il y aurait trop d'informations de bibliothèques/extensions/modules divers, et que cela pourrait gêner les recherches. Mais si le tout est bien classifié, ça ne devrait pas poser de problème.
(oui par exemple, j'envisagerais de mettre de la doc SDL là-dedans)

Ma position n'est pas forcément fixe sur ce sujet. Mais vu le temps que demandera la réalisation du projet, j'ai le temps d'y réflechir.

N'hésitez pas à faire part d'autres avis

Et ah oui, un dernier truc :
je n'exclus pas un recopiage total ou partiel du man ou de la doc officielle du langage concerné, tant que c'est légalement permis.

Je suis globalement pour, mais pour moi, il faudrait faire (un peu comme flickr, etc) un système de "tags".

Par exemple, pour une page sur par exemple "malloc", il y aurait comme tags "C, allocation de mémoire, stdlib.h, C89, C99" et cetera. Comme ça, si je veux accéder par exemple à toutes les fonctions de stdlib.h, hop, une joli liste et ça marche

Je sais pas comment tu vois les choses, mais pour moi c'est le seul moyen de faire un truc bien, qui trie bien, etc (en plus, ça devrait pas être très dur à coder, même si ça fait longtemps que j'ai pas fait de gestion de bdd).

Donc bon, si t'as besoin d'aide, je veux bien aider, et si ça aboutit un jour, je suis prêt à participer (si le système est pas foireux bien sur ).

Ca serait vachement cool dans le sens uniformisation. Avoir une structure définie et partout pareil pour les pages de doc, et ce plus ou moins pour tous les langages, c'est super sympa !

Bon courage ca en vaut le coup

J'achète !!

Ouais moi aussi je soutiens. Par contre petite question tu compte faire ça en français ou en anglais ?

Salut Elentar, ca fait pas mal de temps que je te connais (fin que je te vois sur les forums), je me rapelle que tu es l'un des premier à m'avoir aidé en PHP quand je débutais sans jugements tout comme Makkydn et targuan. (mon ancien pseudo etait guismo1er, meme mon image perso était

)

Fin bref, je veux bien t'aider dans ton projet, car en plus je suis à la recherche d'un projet.

Bonne soirée à toi.

ZyggiX

Citation : Duael
Moi aussi.

Egalement pour

Si ça abouti commencez par python

php, c'est pas vraiment la peine, la doc en ligne est suffisamment fournie.

drexil > En fait, je ne voyais pas vraiment ça comme ça. Mais c'est une idée très intéressante... Par contre ce n'est pas quelque chose de si facile à coder... enfin, si. Mais dans le sens où ça change quand même pas mal la façon de penser du script.
Mon idée était simplement de faire une recherche comme dans la doc PHP dans la liste de noms pour un tel langage (ou tous), si résultat unique on affiche directement, sinon on affiche la liste des résultats.

Le gros problème que me pose cette idée c'est que ça ralentit forcément les recherches dans le sens où même si le résultat est évident, il y aura forcément une liste de résultats vu qu'on fonctionne par tags... et tu perdras du temps par rapport à une doc officielle.
Enfin... c'est à creuser, pas forcément facile de penser un système à la fois complet, simple et performant...

Ou alors : faire simplement deux boutons, comme la recherche sur wikipedia : consulter (= recherche exacte sur le nom) ou rechercher (= recherche sur la liste de tags). Enfin, est-ce que c'est vraiment le plus adapté ?

Sinon autrement : pour la v1, je ne veux pas faire trop complexe.
Passer trop de temps à perfectionner et incorporer des systèmes complexes sur le site avant de le publier, ça finira par me donner envie d'abandonner avant de sortir.
Le seul problème c'est que je ne veux pas avoir à refaire totalement le site de fond en comble pour ajouter une fonctionalité parce que la base sera assez mal pensée, alors je dois quand même voir assez loin... bref, je verrai. j'vais me lancer dans des petits schémas et une todolist, et me fixer des objectifs précis pour la v1 alliant simplicité et "base solide".

winzou & Duael >

playest > français uniquement.
En fait... la langue pour l'instant ça me pose un seul problème : celui du dns.
Parce que dans un premier temps, je suis sûr de faire un site français et rien d'autre, mais imaginons, après ? Je serais bien ennuyé avec un "documentationglobaleenfrancais.com" ( )
Surtout que ce genre de site est extrèmement facile à adapter dans d'autres langues, il n'y a à peu près rien à faire, ce n'est pas un site communautaire comme le SdZ.
Alors voilà, je ne suis pas fixé sur le DNS à cause de ça, sinon j'avais pas mal.
Si vous avez des propositions de nom de domaine, n'hésitez pas
Mais bien sûr, c'est loin d'être le plus pressé, il ne faut pas mettre la charrue avant les boeufs...

ZyggiX > Vi je me souviens très bien de toi, ne t'inquiète pas
Je ne sais pas vraiment si j'ai besoin d'aide.
J'ai l'architecture globale du code dans ma tête et je ne verrais pas vraiment coder ça autrement que seul... mais après, rien ne dit que j'aurais besoin de bras, je ne sais pas encore, je n'ai pas organisé le développement de A à Z non plus.
Je te contacte si j'ai besoin de quelqu'un, et en tous cas merci de t'être proposé

strucky > Ben ça sera à vous de choisir par quoi commencer, ça sera pas un wiki pour rien
Mais si le site est bien abouti, il sera aussi pratique que les docs officielles en ligne les plus efficaces. Alors ça peut ne pas être si inutile que ça

Je suis pour c'est sur. En espèrant que cela aboutisse.

Rosme

Je suis pour cette doc, c'est vrai que cela serait sympa, en plus une sorte de wiki accés sur les zéros, pour prendre chaque fonction ou autre, par le début, contrairement à d'autre doc.
Pour le système de wiki, il faudrait quelque chose de simple à utiliser.

Tu comptes commencer par quel langage ?
J'imagine que commencer à mettre Php, Mysql, C, Phython, Java tout en bloc serait vraiment énorme, alors pourquoi ne pas d'abord par exemple publier les langages dérivés du C (vu que la demande est plutôt là par manque de doc officielle), ensuite les langages web, etc.
Quel serait le niveau de protection des pages ? Il faudrait soumettre un article et attendre qu'il soit validé, un peu comme les tutos des zéros ?
En tout cas, bonne chance, ce site devrait attirer beaucoup de monde

Citation : Elentar

Non, pour moi il y aurais bien sur un "recherche" qui cherche juste dans la doc d'un language (ou de tous) et qui ne s'occupe pas des tags, et d'un autre côté un truc qui permet de trouver tous les articles ayant le même tag.

En fait le seul avantage des tags que je vois c'est de permettre de générer des listes se rapportant au même sujet (mais n'est-ce pas son seul avantage?).
Après c'est sur qu'il faut voir le rapport vitesse/utilité, et garder ou non cette idée.

PS: c'est juste une idée que j'ai, tu peux très bien ne pas l'utiliser et avoir un super système hein

Eldalion > on commencera certainement par tous, mais ça sera à vous de voir, une fois encore c'est un wiki donc vous y mettrez ce que vous voudrez.

Concernant le "niveau de protection" j'en ai une idée bien précise.
Il y aura trois niveaux de membre.
1/ "membre simple"
2/ "membre de qualité" (nom non-définitif of course)
3/ administrateur

Il y aura beaucoup de membres de qualité et peu d'administrateurs.

Les membres de qualité auront un seul pouvoir supplémentaire : celui de pouvoir "authentifier" et "désauthentifier" une page du manuel.
Ces membres n'ont pas besoin d'être hyper-compétents, mais surtout et avant tout d'être raisonnables, dans le sens ils n'iront pas au delà de leurs compétences.

Une page de la doc authentifiée est supposée assez complète et exempte d'erreurs (d'où la nécessité de membres pouvant juger de ça).
Une fois authentifiée, cette page sera interdite en écriture aux simples membres, qui pourront bien sûr soumettre des critiques/améliorations/remarques par un système de commentaire.

Les "membres de qualité" seront élus, mais ça sera un processus très courant, ce n'est vraiment pas quelque chose d'exceptionnel.
Un membre que personne ne connais et qui participe positivement pendant un certain laps de temps pourra devenir assez facilement "membre de qualité".

Les administrateurs auront en plus de ça la possibilité de réellement supprimer un article, un historique, de bannir un membre, etc.

Je en sais pas si je me suis bien exprimé, si un point n'est pas très clair faites le moi remarquer

drexil > franchement je sais pas.
Je trouve que c'est une bonne idée, mais ça pose un certain problème pour avoir un système efficace et pleinement cohérent.
D'autre part, c'est assez facile à ajouter, ça ne suggère pas de changements radicals du 'noyau' du script, donc je ne l'envisagerai pas trop pour une v1, mais après qui sait...

question simple, que pouvons nous faire?

Je comprends pas la question.
Qu'est-ce que vous pouvez faire pour aider le projet, ou qu'est-ce que les simples membres auront comme droits sur le site ?

Qu'est-ce que vous pouvez faire pour aider le projet,

Pour le moment pas grand chose, si ce n'est me donner des idées ou critiquer les miennes
Je vais commencer par coder la base moi-même.
Ensuite, je ne sais pas, mais ça ne sera pas demain...

Hooah j'approuve l'idée.

C'est vrai que ce serait vraiment cool d'avoirune doc complète avec des fiches présentées de la meêm manière pour plusieurs langages.

Tu as pensé à un système qui permetterait de gérer plusieurs langues ?

Elentar > je pense que le mieux serait quelquechose entre les tags (style dailymotion) et les catégories de mediawiki.

Rifleman >Citation : playestCitation : Elentar
Donc au final, il y aura au départ français uniquement, et après éventuellement d'autres langues... On verra ! De toutes le site sera conçu de manière à être multilingue sans problème (et ça sera assez facile). Le seul problème que ça posera sera de trouver le ndd une fois la v1 prête.

minirop > peut-être oui...
La classification et le fonctionnement réel de la recherche c'est un peu mon problème du moment. J'y réflechis.