IdentifiantMot de passe
Loading...
Mot de passe oublié ?Je m'inscris ! (gratuit)
Navigation

Inscrivez-vous gratuitement
pour pouvoir participer, suivre les réponses en temps réel, voter pour les messages, poser vos propres questions et recevoir la newsletter

Embarqué Discussion :

Conseil pour publier un projet


Sujet :

Embarqué

  1. #1
    Membre averti Avatar de electroremy
    Homme Profil pro
    Ingénieur sécurité
    Inscrit en
    juin 2007
    Messages
    526
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 40
    Localisation : France, Doubs (Franche Comté)

    Informations professionnelles :
    Activité : Ingénieur sécurité
    Secteur : Industrie

    Informations forums :
    Inscription : juin 2007
    Messages : 526
    Points : 409
    Points
    409
    Par défaut Conseil pour publier un projet
    Bonjour,

    Mon projet d'interface homme machine, consistant en un écran tactile pilotable par Ethernet avec de petits µC genre Arduino arrive à son terme.
    Les cartes sont faites avec un Arduino UNO + Shield Ethernet II + Ecran 320x240 9341 avec dalle tactile.
    Les cartes fonctionnent en client HTTP.

    Je termine actuellement les tests en conditions réelles (plusieurs interfaces sur un serveur fait avec un µC)

    Je souhaite publier le projet, pour qu'il soit exploitable par d'autres.
    Difficulté supplémentaire : qu'il soit utilisable par la communauté Arduino, qui compte beaucoup de débutants ou de niveaux "intermédiaire"

    Je cherche les bonnes pratiques pour la publication.

    Je sais déjà que je dois :
    - remplacer les nombres magiques par des #defines (parce que sinon, c'est totalement incompréhensible sauf par moi )
    - uniformiser les noms des variables
    - mettre tous les commentaires en anglais
    - mettre tous les noms de variables en anglais (quoi, la "soupe" moitié anglais / moitié français ne convient pas au monde entier ? )
    - réaliser une bonne documentation, avec des exemples, la documentation devra parler du matériel et du logiciel

    Le code est fortement optimisé, ce qui nuit à la lisibilité, les astuces doivent faire l'objets de commentaires explicites.
    La version finale occupe 100% de la ROM, pas un octet de rab' mais les fonctionnalités sont complètes pas de gâchis

    Je pense faire la documentation en deux versions : anglais et en français. Elle sera en PDF ce qui permet d'avoir des illustrations, des tableaux...

    Le projet sera accompagné par des outils "annexes" :
    - éditeur de bitmap fait en Visual Basic .NET
    - éditeur de police de caractères fait en Visual Basic .NET
    - exemple de serveur en Visual Basic .NET
    - exemple de serveur Arduino (projet .INO)

    Ces outils annexes seront publiés avec leur sources et leur binaires.
    La document expliquera comment les utiliser.
    Les logiciels en Visual Basic .NET seront en anglais et en français

    La publication sera faite sur GitHub, et en parallèle sur mon site web

    Est-ce qu'il y a des conventions à respecter, attendues par la communauté GitHub en général et Arduino en particulier ?

    Je prend cet aspect au sérieux, car beaucoup de projets intéressants n'ont pas rencontré de succès faute d'être accompagnés par une documentation de qualité et un code permettant aux autres de savoir comment le modifier.

    A bientôt
    Quand deux personnes échangent un euro, chacun repart avec un euro.
    Quand deux personnes échangent une idée, chacun repart avec deux idées.

  2. #2
    Membre averti Avatar de electroremy
    Homme Profil pro
    Ingénieur sécurité
    Inscrit en
    juin 2007
    Messages
    526
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 40
    Localisation : France, Doubs (Franche Comté)

    Informations professionnelles :
    Activité : Ingénieur sécurité
    Secteur : Industrie

    Informations forums :
    Inscription : juin 2007
    Messages : 526
    Points : 409
    Points
    409
    Par défaut
    Bonjour,

    Je suis étonné de ne pas avoir de réponse

    C'est plutôt dans l'intérêt des membres de ce forum, car le projet que je vais publier sera pour la communauté, profitez-en pour dire ce que vous voulez

    Et pour dire les choses que vous n'aimez pas dans les codes sources publiés

    A bientôt
    Quand deux personnes échangent un euro, chacun repart avec un euro.
    Quand deux personnes échangent une idée, chacun repart avec deux idées.

  3. #3
    Responsable Arduino et Systèmes Embarqués

    Avatar de f-leb
    Homme Profil pro
    Enseignant
    Inscrit en
    janvier 2009
    Messages
    11 309
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 50
    Localisation : France, Sarthe (Pays de la Loire)

    Informations professionnelles :
    Activité : Enseignant

    Informations forums :
    Inscription : janvier 2009
    Messages : 11 309
    Points : 49 240
    Points
    49 240
    Billets dans le blog
    17
    Par défaut
    Salut,

    Citation Envoyé par electroremy Voir le message
    La publication sera faite sur GitHub, et en parallèle sur mon site web

    Est-ce qu'il y a des conventions à respecter, attendues par la communauté GitHub en général et Arduino en particulier ?
    Il reste à se faire connaître : l'Arduino Project Hub à l'international, et là où tu sais pour la communauté francophone

  4. #4
    Membre averti Avatar de electroremy
    Homme Profil pro
    Ingénieur sécurité
    Inscrit en
    juin 2007
    Messages
    526
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 40
    Localisation : France, Doubs (Franche Comté)

    Informations professionnelles :
    Activité : Ingénieur sécurité
    Secteur : Industrie

    Informations forums :
    Inscription : juin 2007
    Messages : 526
    Points : 409
    Points
    409
    Par défaut
    Bonjour,

    Je pense que ferais d'abord une publication que sur ce forum

    En fonction de la discussion, je pourrais modifier le projet et la doc (typiquement une chose que personne ne comprend ou une fonctionnalité à laquelle je n'avais pas pensé et que tout le monde réclame), pour ensuite publier sur GitHub et sur mon site web

    A bientôt
    Quand deux personnes échangent un euro, chacun repart avec un euro.
    Quand deux personnes échangent une idée, chacun repart avec deux idées.

  5. #5
    Modérateur

    Avatar de Vincent PETIT
    Homme Profil pro
    Ancien développeur matériel électronique (Hard/Soft)
    Inscrit en
    avril 2002
    Messages
    2 952
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 39
    Localisation : France, Pas de Calais (Nord Pas de Calais)

    Informations professionnelles :
    Activité : Ancien développeur matériel électronique (Hard/Soft)
    Secteur : Service public

    Informations forums :
    Inscription : avril 2002
    Messages : 2 952
    Points : 10 636
    Points
    10 636
    Par défaut

    Je n'ai pas de conseils particuliers mais je me suis fait 2 réflexions.

    Il y aura 2 types de personnes intéressées :
    - Celui qui veut simplement utiliser, il cherche une brique logicielle/matérielle à ajouter à son projet sans se pencher sur les problèmes d'intégration, pour celui là il faut que ce soit hyper simple. Si le gars doit commencer à éplucher la doc pour faire un réglage ou autre il laissera tout tomber (trop compliqué) faute de temps ou d'envie de se pencher sur ces questions.
    - Celui qui veut intégrer ton projet au sien, il doit maîtriser ce qu'il se passe et à besoin de comprendre ce que tu as fait pour que tout se passe bien. Il lui faut une doc complète.


    Si tu vises Arduino, la grande majorité des utilisateurs fera partie de la première catégorie. Ce que je dis n'est pas péjoratif, s'il y a des shields à vendre c'est justement pour ne pas avoir à se pencher sur l'intégration du hard. Idem quand on télécharge une bibliothèque, c'est principalement pour l'utiliser et moins pour la décortiquer.

    Ce que tu as fait et ce que font certains membres ici (qui savent ce qui se passe sous le capot) ne reflète absolument pas la tendance des utilisateurs de Arduino.


    ps : si je le dis autrement ; celui qui publie du code open-source ne cible pas les utilisateurs (qui n'y connaissent pas assez pour regarder le code), il cible les autres développeurs et ceux là dans le monde Arduino représentent une minorité. Mieux vaut peut être cibler la majorité en leur annonçant simplement les limites de ton projet ?
    La science ne nous apprend rien : c'est l'expérience qui nous apprend quelque chose.
    Richard Feynman

  6. #6
    Membre averti Avatar de electroremy
    Homme Profil pro
    Ingénieur sécurité
    Inscrit en
    juin 2007
    Messages
    526
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 40
    Localisation : France, Doubs (Franche Comté)

    Informations professionnelles :
    Activité : Ingénieur sécurité
    Secteur : Industrie

    Informations forums :
    Inscription : juin 2007
    Messages : 526
    Points : 409
    Points
    409
    Par défaut
    Bonjour,

    Je suis d'accord avec toi

    Ma documentation sera en deux parties :

    - la première sera une "datasheet" en PDF, qui explique comment utiliser mon projet comme si c'était un composant ou un "kit" du commerce ; je devrais aussi faire une partie sur le matériel étant donné que les utilisateurs devront faire un peu de câblage (le shield Ethernet se clipse en 2 secondes mais il faut câbler l'écran, le convertisseur 3.3V/5V et une dizaine de composants discrets)

    - la deuxième partie sera la documentation du code, sous formes de commentaires et d'explications dans les fichiers sources

    Les simples utilisateurs se contenteront d'utiliser la datasheet et les petits logiciels annexes sans rentrer dans le code.
    Ils auront quand même à coder leur propre serveur eux-même pour piloter mes interfaces, donc ce projet ne s'adresse pas non plus à des personnes n'y connaissant rien, même s'ils pourront faire ce serveur avec un système autre que Arduino (PIC, Raspberry PI, ...).

    Les codeurs voudront se plonger dans le source pour adapter mon projet ou juste reprendre quelques fonctions.
    Ils auront besoin de la datasheet mais aussi de la documentation incluse dans les fichiers sources.

    Je sais comment faire pour la datasheet.
    Mon logiciel CiDess (http://cidess.free.fr/index-fr.html), qui sert à dessiner des circuits imprimés, a été une bonne expérience pour savoir comment rédiger un mode d'emploi et faire un logiciel utilisable par des personnes n'ayant pas de connaissances approfondies en informatique

    C'était plus pour la documentation du code que j'avais plutôt des questions - histoire aussi qu'on se moque pas de moi
    Je pense avoir réussi à faire un code relativement bien documenté dans un anglais correct.

    A bientôt
    Quand deux personnes échangent un euro, chacun repart avec un euro.
    Quand deux personnes échangent une idée, chacun repart avec deux idées.

  7. #7
    Responsable Arduino et Systèmes Embarqués

    Avatar de f-leb
    Homme Profil pro
    Enseignant
    Inscrit en
    janvier 2009
    Messages
    11 309
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 50
    Localisation : France, Sarthe (Pays de la Loire)

    Informations professionnelles :
    Activité : Enseignant

    Informations forums :
    Inscription : janvier 2009
    Messages : 11 309
    Points : 49 240
    Points
    49 240
    Billets dans le blog
    17
    Par défaut
    Salut,

    Sur developpez.com tu pourrais "faire la promotion" du projet en ouvrant ton blog sur developpez (voir Les nouveaux Blogs du Club). C'est facile à utiliser (tu rédiges un billet comme pour une discussion forum) et un billet peut etre mis en avant en étant publié comme actualité sur le portail.

  8. #8
    Membre averti Avatar de electroremy
    Homme Profil pro
    Ingénieur sécurité
    Inscrit en
    juin 2007
    Messages
    526
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 40
    Localisation : France, Doubs (Franche Comté)

    Informations professionnelles :
    Activité : Ingénieur sécurité
    Secteur : Industrie

    Informations forums :
    Inscription : juin 2007
    Messages : 526
    Points : 409
    Points
    409
    Par défaut
    Pourquoi pas, je n'ai jamais utilisé cette fonction de blog de developpez.net c'est l'occasion

    Question à la con : le "code" du blog c'est du BB code ? (donc facilement réutilisable, et facilement convertible en HTML par exemple si je veux publier la même chose sur mon site perso) ?

    A bientôt
    Quand deux personnes échangent un euro, chacun repart avec un euro.
    Quand deux personnes échangent une idée, chacun repart avec deux idées.

  9. #9
    Responsable Arduino et Systèmes Embarqués

    Avatar de f-leb
    Homme Profil pro
    Enseignant
    Inscrit en
    janvier 2009
    Messages
    11 309
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 50
    Localisation : France, Sarthe (Pays de la Loire)

    Informations professionnelles :
    Activité : Enseignant

    Informations forums :
    Inscription : janvier 2009
    Messages : 11 309
    Points : 49 240
    Points
    49 240
    Billets dans le blog
    17
    Par défaut
    Salut,

    Je ne sais pas si on peut le convertir facilement en html, mais oui c'est du BB code comme dans les discussions du forum.

  10. #10
    Membre averti Avatar de electroremy
    Homme Profil pro
    Ingénieur sécurité
    Inscrit en
    juin 2007
    Messages
    526
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 40
    Localisation : France, Doubs (Franche Comté)

    Informations professionnelles :
    Activité : Ingénieur sécurité
    Secteur : Industrie

    Informations forums :
    Inscription : juin 2007
    Messages : 526
    Points : 409
    Points
    409
    Par défaut
    OK merci

    je compte faire une doc et elle devra être :
    - dans le blog
    - sur ma page perso
    - dans une version hors ligne

    Pour la version hors ligne, je pense que je vais laisser tomber le PDF au profit d'un dossier avec la page HTML consultable depuis le disque dur.
    C'est plus simple, et surtout une page WEB n'a pas de "hauteur" maxi, ce qui évite d'avoir par exemple de longs tableaux "coupés" sur plusieurs pages.
    Après ça sera plus difficilement imprimable mais on peut sortir l'argument écolo zéro papier

    Pour éviter de refaire X fois les choses, je pense que le mieux à faire est que je rédige ma doc originale en BB code dans un fichier texte, puis je me fait une petite "moulinette" qui va me convertir ça en HTML pour la mise en page de mon site, et en même temps générer la version hors ligne.

    En cas de mise à jour, je modifie un seul fichier et hop je peux mettre à jour le blog, mon site et la doc.

    L'outil de blog de developpez.net impose-t-il de faire le blog en plusieurs morceaux ou alors on peut avoir un seul long texte, contenant des "saut de pages" ?

    Si c'est en morceaux ça risque d'être un peu pénible pour la mise à jour (faire X copier coller pour chaque morceau)

    Et comment ça se passe pour les images ? Il va y en avoir un paquet... au pire je peux mettre dans le BB code des liens vers les images hébergées sur mon site web, mais cela rend dépendant le blog de mon site et c'est pas bon (si mon site tombe, le blog aussi, comme d'ailleurs pour les images dans les anciens posts de forums qui ne sont plus visibles...)

    A bientôt
    Quand deux personnes échangent un euro, chacun repart avec un euro.
    Quand deux personnes échangent une idée, chacun repart avec deux idées.

  11. #11
    Responsable Arduino et Systèmes Embarqués

    Avatar de f-leb
    Homme Profil pro
    Enseignant
    Inscrit en
    janvier 2009
    Messages
    11 309
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 50
    Localisation : France, Sarthe (Pays de la Loire)

    Informations professionnelles :
    Activité : Enseignant

    Informations forums :
    Inscription : janvier 2009
    Messages : 11 309
    Points : 49 240
    Points
    49 240
    Billets dans le blog
    17
    Par défaut
    Citation Envoyé par electroremy Voir le message
    L'outil de blog de developpez.net impose-t-il de faire le blog en plusieurs morceaux ou alors on peut avoir un seul long texte, contenant des "saut de pages" ?

    Si c'est en morceaux ça risque d'être un peu pénible pour la mise à jour (faire X copier coller pour chaque morceau)
    Les billets sont en principe assez courts (ceci dit, c'est relatif !), écrits en plusieurs parties si c'est un peu long. Pas de sauts de page.


    Citation Envoyé par electroremy Voir le message
    Et comment ça se passe pour les images ? Il va y en avoir un paquet...
    Comme sur le forum, c'est le même éditeur de message avec son bouton [Insérer une image].


    Citation Envoyé par electroremy Voir le message
    au pire je peux mettre dans le BB code des liens vers les images hébergées sur mon site web, mais cela rend dépendant le blog de mon site et c'est pas bon (si mon site tombe, le blog aussi, comme d'ailleurs pour les images dans les anciens posts de forums qui ne sont plus visibles...)
    En effet c'est pas terrible, mais pourquoi héberger à deux endroits ? C'est pénible pour les mises à jour, choisis l'endroit qui t'arrange pour publier puis mets un lien pour les autres endroits.

    Sinon, pourquoi pas au format Article ? Tu aurais ton domaine tonpseudo.developpez.com pour mettre en ligne tes docs. Evidemment le processus est plus long mais il y a des avantages. Et puis tu peux combiner billets de blog + articles sur developpez...

  12. #12
    Membre averti Avatar de electroremy
    Homme Profil pro
    Ingénieur sécurité
    Inscrit en
    juin 2007
    Messages
    526
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 40
    Localisation : France, Doubs (Franche Comté)

    Informations professionnelles :
    Activité : Ingénieur sécurité
    Secteur : Industrie

    Informations forums :
    Inscription : juin 2007
    Messages : 526
    Points : 409
    Points
    409
    Par défaut
    Bonjour,

    Peut être alors juste un blog ou un article "introductif", qui renvoie vers le site, tout en proposant aux visiteurs la possibilité de discuter

    Selon moi, le meilleur endroit :
    - pour échanger, poser des questions (en français) c'est le forum Developpez.net
    - pour publier la doc du projet c'est un site web dédié
    - pour publier le source c'est Github (et aussi échanger en anglais)

    A bientôt
    Quand deux personnes échangent un euro, chacun repart avec un euro.
    Quand deux personnes échangent une idée, chacun repart avec deux idées.

  13. #13
    Responsable Arduino et Systèmes Embarqués

    Avatar de f-leb
    Homme Profil pro
    Enseignant
    Inscrit en
    janvier 2009
    Messages
    11 309
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 50
    Localisation : France, Sarthe (Pays de la Loire)

    Informations professionnelles :
    Activité : Enseignant

    Informations forums :
    Inscription : janvier 2009
    Messages : 11 309
    Points : 49 240
    Points
    49 240
    Billets dans le blog
    17
    Par défaut
    Tu as toutes les armes en main

Discussions similaires

  1. Réponses: 0
    Dernier message: 12/09/2010, 14h20
  2. Besoin de conseil pour démarrer un projet de 3D
    Par ibi0tux dans le forum Projets
    Réponses: 14
    Dernier message: 07/11/2009, 08h31
  3. Conseils pour création de projet
    Par tdenis13860 dans le forum Autres
    Réponses: 0
    Dernier message: 03/02/2008, 14h40
  4. Conseils pour un bon projet Web ASP.NET
    Par sebastien00 dans le forum ASP.NET
    Réponses: 5
    Dernier message: 14/01/2008, 01h04
  5. Réponses: 5
    Dernier message: 21/09/2007, 18h29

Partager

Partager
  • Envoyer la discussion sur Viadeo
  • Envoyer la discussion sur Twitter
  • Envoyer la discussion sur Google
  • Envoyer la discussion sur Facebook
  • Envoyer la discussion sur Digg
  • Envoyer la discussion sur Delicious
  • Envoyer la discussion sur MySpace
  • Envoyer la discussion sur Yahoo