Avant toute chose merci de (re)prendre connaissance de la charte et de la respecter.
Pour résumer :
- Avant de poser une question, je cherche si la réponse existe
- Je suis poli, courtois et je respecte tout un chacun sur le forum
- Si un post m'agace : je m'en éloigne plutôt que de répondre d'une façon qui pourrait être mal interprétée


Il n'est jamais du luxe que de rappeler des choses simples :
Courtoisie, amabilité, politesse et bonne humeur sont les maîtres mots pour un forum sympathique, bienveillant et accueillant :)

Toute la communauté vous remercie

Recherche personne pour faire de la doc sur les modules

Retrouvez les informations officielles de Jeedom (nouvelle version, nouveaux lancements, tutos...)
Anou
Timide
Messages : 1
Inscription : 30 août 2017, 09:34

Re: Recherche personne pour faire de la doc sur les modules

Message par Anou » 30 août 2017, 09:38

loic a écrit :
14 juil. 2015, 12:37
Bonjour,

Dans le but de toujours plus facilité l'accessibilité à Jeedom nous sommes à la recherche de personnes pour faire des documentations sur les modules enOcean/Rfxcom. Cela demande pas mal de temps mais apportera un gros plus à Jeedom.

Voici des exemples de doc (déjà faite pour le zwave/edisio) :

https://jeedom.fr/doc/documentation/zwa ... rnode.html
https://jeedom.fr/doc/documentation/edi ... Volet.html

Les doc doivent être faite en asciidoc, voila des exemples pour les doc actuels (zwave/edisio) :
https://github.com/jeedom/doc-zwave-mod ... /doc/fr_FR
https://github.com/jeedom/doc-edisio-mo ... /doc/fr_FR

Bien sur tout travail (si correcte bien évidement) sera récompensé par des plugins/backups cloud/services pack

Merci d'avance pour les courageux qui tenteront. Si vous faite une doc sur un module dite le histoire que vous vous retrouviez pas à 2 sur le même module.

Je peux aider pour le plugin RFXcom.
J'ai pas mal de modules thermo/hydro, pince ampèremétrique, pluvio, anémo et une sonde piscine (pas utilisée pour le moment).
Dès que j'ai un peu de temps (pas facile avec ces journées à rallonge !).

yves273
Timide
Messages : 205
Inscription : 18 janv. 2016, 11:13

Re: Recherche personne pour faire de la doc sur les modules

Message par yves273 » 20 sept. 2017, 09:00

Bonjour,

J'avais pour objectif de corriger une doc d'un plugin, j'ai réussi à faire mes changements qui ont été validés par le développeur.
Pendant cette étape je l'ai fait intuitivement sans doc avec quelques infos récupérés ça et là (comme le pull request)
Voulant me faire une petite doc perso pour d'autres occasions j'ai eu beaucoup plus de mal à reproduire ce que j'avais fait car j'ai pris les subtilités de l'IHM (très américaine) en pleine figure et en cherchant mieux je me suis retrouvé sur ce fil.

La proposition de @tag du 24 aout m'a permis de conforter mes connaissances mais si c'est le point d'entrée d'un contributeur dans l'outil, il y a de quoi être repoussé.

1- je pense donc que ta dernière partie doit être le point d'entrée (avec les bons mots et les copies d'écrans) c'est ce que j'ai du faire
Tu fork la documentation jeedom vers ton profil
tu ajoute quelque chose
tu fais un pul request
tu ne peux pas le merger, il est juste sous soumis ton pull request, il faut qu'une personne en charge du repos valide ton PR ;).
2- j'ai d'autres interpellations
-la structure du document n'est pas évoquée et la il y a des variantes suivant le développeur
-l'arborescence des documents (master, beta) et les conséquences sur les maj du plugin d'un document mergé c'est important aussi, dans mon cas une branche patch-1 a été créée, que comprendre?

Une interface complexe est mise à disposition il faut en simplifier la compréhension au maximum, autrement cela ne peut pas marcher.
Les développeurs sont culturellement allergiques à écrire, aux docs, aux changelog..., là c'est l'expérience qui parle mais n'avez vous pas remarqué que le marketing de l'envie marche bien (aussi pour les plugins jeedom) mais derrière il y a un gros gaspillage d'objets qui finissent dans les fonds de tiroir.
Comment voulez-vous faire quand on reçoit une notice en chinois et là github c'est un peu du chinois.

TaG
Actif
Messages : 746
Inscription : 26 oct. 2016, 11:02

Re: Recherche personne pour faire de la doc sur les modules

Message par TaG » 21 sept. 2017, 23:01

Je n'ai pas oublié ce sujet, j'ai juste pas mal de choses en cours. Je vais y arriver.

Après je suis un pauvre débutant, j'essayerai de faire au mieux. Les corrections seront les bienvenues :)!

Répondre

Revenir vers « Annonces officielles »

Qui est en ligne ?

Utilisateurs parcourant ce forum : Aucun utilisateur inscrit et 1 invité