Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rédiger un compte-rendu #40

Closed
5 of 8 tasks
bj0rge opened this issue Mar 27, 2015 · 51 comments
Closed
5 of 8 tasks

Rédiger un compte-rendu #40

bj0rge opened this issue Mar 27, 2015 · 51 comments
Labels

Comments

@bj0rge
Copy link

bj0rge commented Mar 27, 2015

Summary of required features

  • Create a memo.
  • Edit a memo.
    • Memo includes Markdown Layout.
    • Link to online pictures (thanks to Markdown)
    • Upload a picture to a memo.
      • Same as above (with drag and drop).
  • Delete the picture attached to a memo.
  • Delete a memo.

Discussion

Issue created with @Yeahger & @valentinlefevre

We try and synthesized the scenario 'writing a memo'. The different steps we were able to identify are the following:

  • Writing the date
  • Writing the place & context
  • Writing down the first impressions & notes
  • Transcribe the interview
  • Labeling the interview
  • Naming the hole memo for referencing it
  • Join meeting review & own notes
  • Transcribe the decisions taken during the meeting

We also understood the need about anchors which is a central feature in the activity of writing a memo.

@benel benel added the Feature label Mar 30, 2015
@edwil13x
Copy link

Pour la conception, on peut distinguer deux approches:

  • Un seul formulaire avec différentes rubriques pour chaque type de mémo.
    Avantages : faciliter à gérer les bugs
    Inconvénients : trop général, oriente moins l'utilisateur
  • Plusieurs formulaires, chaque type de mémo ayant un formulaire.
    Avantages : plus en accord avec la méthode, avoir des formulaires personnalisés
    Inconvénients : plus de travail pour les développeurs

Quel approche vous conviendrez?

Ci-joint, les différents types de comptes rendus :

img_20150330_165223

@pixel-3092189
Copy link

According to the feature #41, we think about including some additionnal features during writing a memo

  • We can associate a piece of text to a tag (For instance : "Personnal notes" or "Behaviour manifestation")
  • These tags can be created by two differents ways
    • With a specific syntax (For instance "\PersonnalNotes{I think he is trying to explain that it was a hard part of his life}")
    • With a WYSIWYG editor

@AndreMarvell
Copy link

@christophe-lejeune, pour rebondir sur la question des types de formulaires lors de la création d'un mémo : Les informations fournies dans les types de comptes rendu sont elles differentes au point d'avoir besoin de formulaires distincts pour chacun d'eux ?

@christophe-lejeune
Copy link
Member

If you refers to the page 30 of the Handbook for Qualitative Analysis, you can see that every memo has the same structure and attributes. This advocates for same (or similar) forms.

Every memo requires :

  • the name of the project : could be the name of the project, or the content of another (theoretical) memo
  • a type : to be picked in a closed list
  • a date : could be automatically inserted
  • an author : the name/id of the user that writes the memo (in some case, multiple authors could be allowed).
  • a title
  • a grounding : the reference of a memo previously written.
  • a body : the content (text or schema) written by the user.

@AndreMarvell
Copy link

Thanks @christophe-lejeune. Knowing that every memo has the same structure, so we will choose the first approach : Only one form with different headings for each type of the memo.

@christophe-lejeune
Copy link
Member

Some precisions :

  • Be sure not to confuse headers (mentioning "fixed" information such as author and date) and tags (which contains interpretation different from one user to another).
  • Hereunder is the English version of the diagram mentioned above
    memo-overall_2

@benel benel changed the title Writing a memo Rédiger un mémo Apr 7, 2015
@mchidaine
Copy link

Here we have 2 mockups :

  • one showing the field note with its tags on one side with the option to add a code note related to this field note;
  • one showing the creation of a new code note once we've clicked on the "add a code note" button

We chose to link the different types of memos by directly having the option to create a memo from another memo; since they're all created in a logical order, it seemed more interesting to link them this way.


@christophe-lejeune
Copy link
Member

It took me a little time to understand the mock-ups. Now it is becoming clear.

Here are some comments, to stimulate our discussion:

  • The content of the field note (on the first mock-up) looks a bit strange. A field note contains usually observation notes or an interview transcript.
  • The GUI of the second mock-up assumes that code notes have something to do with LaSuli. Well, this makes sense given that LaSuli is a coding add-on and that code notes are related to coding. However, don't you think that some users could be willing to fill some code notes without going through LaSuli?
  • When I hit "add a code note", is the created code note linked directly to the original field note, or to the highlighted text, or to one of the code featured in LaSuli ? What if I do not select any element before hitting the button?
  • The second mock-up is a creation panel. Will the same panel be used to edit the memo? If it is the case, how can the user see the link with other memos? In such a case, will the creation date be replaced by the edit date? For instance, Weft-QDA keeps two dates (creation and last edit).

@pixel-3092189
Copy link

As we said during the meeting this morning between Aurelien Benel and the friday TP's group, we finally concluded that it would be a good idea to build a software which includes the functionnalities of LaSuli but doesn't require the Firefox extension itself.
On the basis of @mchidaine's mock-up, we tried to complete it in adding some functionnalities previously mentionned by @christophe-lejeune in #40 (comment).
We have begun two mock-ups, and we need to know if its represent more respectively the work of writing a coding memo.

Writing a memo

Writing a memo

Writing a coding memo

Writing a coding memo
These two mock-ups need to be continued and completed. The second one about writing a coding memo isn't finished yet. We invite anyone to continue the mock-up.

#EDIT : 17/04/2015 -> The 2 mock-ups has been updated, especially the second one.

@valentin-bonino
Copy link

@salamata and I worked on a form to create memos. In the mock up we made, we create a new field note, where we can fill in the authors, the title of the memo and the body. But the same type of form can be used for other types of note. There is no selection of type, because "create a new memo" button will be on the previous memo.

creer un compte-rendu de terrain

@pixel-3092189
Copy link

@valentin-bonino, you obviously didn't see what we said in #40 (comment). Indeed we made a check-up with @benel the last friday (April, 10th), and we talked about two main things :

  • The functionnalities of LaSuli have to be included in cassandre 2, and cassandre doesn't have to require the "LaSuli" firefox extension anymore. In your mock-up, it's appear that you didn't consider the LaSuli functionnalities.
  • The second point is the coding memo that doesn't appear too in your mock-up.
    Please, if there are some points to clarify (mock-ups, the way we see things, etc..), please post a comment before creating a new mock-up.

@salamata
Copy link

OK! It was just the first mockup version 1.0. We are going to change it and considerer your comment. I didn't know that we have to use lasuli with the memo.

@christophe-lejeune
Copy link
Member

Not allowing to pick the memo type is a good idea. I see at least two benefits.

  • It "forces" the user to choose a type when hitting the button.
  • By doing so, we also avoid untyped memos.

However, when rethinking about your mock-ups, be aware of the following :

  • Both a code note and a theoretical note can be grounded in a code note, for instance. Thus, more than one button have to be provided from the memo page (depending on its type). Check the diagram above, to review all possible follow-up type (and, thus, all needed buttons).
  • While a code note is basically grounded in only one memo (either a field note or a code note), theoretical notes are mainly based on more than one memo (theoretical notes are used for comparison). The theoretical note could also be created through a button, but the interface need to allow to add additional groundings.

NB: Perhaps another issue could be dedicated on mock-ups to read memo, given the edit window will be slightly different.

@edwil13x
Copy link

Un mémo pouvant pointer vers plusieurs types de mémos (ex: compte-rendu théorique vers compte-rendu opérationnel, analytique et schématisation), l'ajout de nouveaux mémos à partir d'un précédent doit permettre de choisir le type. Je propose d'illustrer ce cas particulier par la maquette suivante.

maquette

@ConstantSIDJUI
Copy link

L'affichage de mémos se faisant en parallèle comme précisé dans le ticket #41, lors de la navigation de mémo en mémo nous devons avoirs des alternatives lorsqu'un mémo est ancré sous plusieurs autres mémos. L'exemple de la figure ci-dessous illustre un cas de navigation lorsque nous sommes au niveau du mémo Compte rendu théorique (Th), nous pouvons naviguer soit vers le mémo Compte-rendu Opérationnel (O) soit vers le mémo Schématisation (S). Dans l'exemple de la figure nous avons choisi de faire une navigation sur la schématisation (à droite de la figure) et l'affichage précise les deux compte-rendus Théoriques sous lesquels la schématisation est ancrée.

11178538_861412693919364_201684130_n

Légende:
C = Compte-rendu de codage
Th = Compte-rendu de Théorique
O = Compte-rendu de opérationnel
S = Shématisation

@ConstantSIDJUI
Copy link

11146011_861413593919274_2038201557_n

La figure ci-dessus représente une maquette pour l'ajout d'un mémo. Cela devient ambigu lorsqu'on se situe au niveau du compte-rendu Théorique (Th) et de la schématisation (S). Étant sur un compte-rendu Théorique (Th) on doit pouvoir ajouter une schématisation. Une fois la schématisation ajoutée et étant donnée qu'une schématisation est ancrée sur deux comptes-rendus Théoriques, on doit pouvoir ajouter le second compte-rendu théorique sur lequel la schématisation est ancrée. Ce qui explique le module en dessous du compte-rendu Théorique après l'ajout d'une schématisation.
Légende:
C = Compte-rendu de codage
Th = Compte-rendu de Théorique
S = Shématisation

@christophe-lejeune
Copy link
Member

Si je comprends bien,

Si c'est bien cela, alors la première maquette relèverait plutôt du #47 (et n'a donc pas sa place ici). Corrigez-moi si je me trompe.

Je ne suis pas certain de mesurer l'apport de la partie gauche de cette première maquette, pour deux raisons.

  • La liste des comptes-rendus sur lesquels s'appuie un compte-rendu est présente dans l'entête. Ne suffit-il pas de cliquer sur celui qui nous intéresse pour s'y rendre ?
  • Afficher les comptes-rendus sur lesquels s'appuie un compte-rendu est certes aisé, dans cet exemple, où 2 comptes-rendus sont concernés. Lorsqu'il seront 10, cet affichage ne risque-t-il pas de devenir plus compliqué ?

En ce qui concerne la deuxième maquette, le module sous le compte-rendu théorique de la partie gauche me semble effectivement constituer une bonne solution. On peut cependant se demander, à nouveau, s'il ne suffirait pas, de permettre les ajouts dans le champ "Ancrage" de l'entête, grâce à un bouton [ + ](comme on le ferait pour les auteurs).

@Yeahger
Copy link

Yeahger commented Apr 24, 2015

Synthèse de la rédaction d'une entrée dans le journal de bord

Cette synthèse a pour but de faire un point sur ce qui a été dit depuis la création de cette issue. C'est également l'occasion de voir si nos réflexions vont dans le bon sens.

Le mot "mémo" entraîne des confusions. On devrait donc plutôt parler "d'entrée du journal de bord". Une entrée est typée (cf schéma #40 (comment) )

À l'exception de la première entrée du journal qui sera un compte-rendu de terrain indépendant, les autres entrées seront ancrées à une ou plusieurs autres entrées.

Au niveau de l'affichage, l'écran sera divisé en deux :

  • à gauche : une vision des documents sur lequel est ancrée l'entrée (vide pour le premier compte-rendu de terrain)
  • à droite : la nouvelle entrée à rédiger

La rédaction d'un compte-rendu sera dépendante du type d'entrée que l'on souhaite rédiger.

  • Une saisie de texte : pour la plupart des compte-rendus
  • Un système de "questions / réponses" : pour le compte-rendu de terrain
  • Un système de marqueurs "Lasuli" : pour l’étiquetage
  • Des diagrammes / schémas (par upload d'images ou éditeur de diagrammes) : pour la schématisation

@christophe-lejeune : Nous attendons vos remarques avant de progresser sur cette issue.

Rédigé avec @valentinlefevre

@christophe-lejeune
Copy link
Member

Merci pour cette très bonne synthèse qui va à l'essentiel. Je ne vois rien à objecter à ce qu'elle contient.

Je me permets juste de compléter la liste des modalités de rédaction des comptes-rendus :

N'hésitez pas à me relancer si quelque chose n'était pas clair. Je suis bien conscient que les schématisations et la table des propriétés nécessitent plus de travail que la "simple" saisie de texte. Elles jouent néanmoins un rôle important dans le travail de conceptualisation en recherche qualitative.

Le projet avance bien. Merci de vos contributions et bon courage pour la suite !

@ConstantSIDJUI
Copy link

Test de recette pour la création d'un compte rendu opérationnel à partir d'un compte rendu théorique.

1- vérifier que le background (tout ce qui c'est fait avant) du compte rendu opérationnel à été bien réaliser si non on doit au préalable:

  • Créer un Projet;
  • créer un compte rendu de terrain;
  • faire un étiquetage;
  • créer un compte rendu de codage;
  • créer un compte rendu théorique;

2- étape de création du compte rendu opérationnel

  • sur la page du compte rendu théorique, cliquer sur le type: compte rendu opérationnel;
  • vérifiez que le compte rendu de coda n'est plus visible;
  • vérifier que le compte rendu opérationnel est visible;
  • renseigner les différent champs (Auteur, Type, etc)
  • cliquer sur enregistrer.

Rédigé avec @salamata

@salamata
Copy link

salamata commented May 5, 2015

Test de recette pour la création d'un compte rendu opérationnel à partir d'un compte rendu théorique avec RSpec syntax :

require 'spec_helper'
feature 'Créer un compte rendu' do
scenario 'for a published article' do
visit '/'
click_on 'Compte rendu théorique'
click_on 'Créer compte rendu opérationnel'
fill_in 'Titre', :with => 'Échantillonnage des dimensions de se motiver'
click_on 'Type', :with => 'compte rendu opérationnel'
fill_in 'Date', :with => '05/05/2015'
fill_in 'ancrage', :with => 'Compte rendu théorique'
fill_in 'URL', :with => [GitHub](https://github.com/Hypertopic/Cassandre/issues)
fill_in 'Memo', :with => 'L''analyse consigne les pistes à suivre dans des comptes-rendus opérationnels. Cela peut impliquer des passages en bibliothèque, orienter la suite du terrain ou suggérer des pistes de conceptualisation à venir.
Dans l''exemple de la construction de maison, les propriétés articulées (à savoir, les "difficultés imprévus" et "se motiver" méritant un approfondissement.
-Se motiver est un processus doté d''une historicité propre: les conditions pour amorcer ce processus différent de celles contribuant à le poursuivre ou à l''arreter. Ces différentes conditions méritent d''être explorées.
-Le rôle que jouent les imprévus dans ce processus dépend de leur nature, de leur nombre, de leur répétition et de leur sévérité. Par ailleurs, les imprévu ne sont évidemment pas seuls à intervenir dans le processus. '
click_on 'Enregistrer'
visit '/'
expect(page).to have_content 'compte rendu opérationnel'
end
end

Rédigé avec @ConstantSIDJUI

@christophe-lejeune
Copy link
Member

Waow. Les choses se concrétisent.

Quelques remarques :

  • Pour être consistante, l'interface ne devrait pas passer de "mémo" à "compte-rendu". Je préconise d'utiliser "compte-rendu" du début à la fin.
  • Le titre devrait toujours différer du type. Le titre d'un compte-rendu opérationnel pourrait être "Échantillonnage des dimensions de se motiver"
  • Dans la mesure où l'utilisateur clique sur un bouton mentionnant le type de compte-rendu, il ne me semble pas utile de lui demander de préciser le type (le système comme l'utilisateur savent de quel type il s'agit). Nous en avions discuté : Rédiger un compte-rendu #40 (comment)
  • De la même manière, dans la mesure où l'utilisateur est identifié, il ne me semble pas non plus utile de lui demander de déclarer qui il est (le système le sait déjà).
  • Enfin, c'est sans doute du détail, mais le contenu proposé ici ne correspond pas vraiment à celui d'un compte-rendu opérationnel.

Voilà, je peux évidemment me tromper. N'hésitez pas à me le signaler le cas échéant.

@supertinou
Copy link

Note : @salamata, tu peux utiliser le formatage Markdown sous forme de code : https://help.github.com/articles/markdown-basics/#code-formatting afin améliorer la visibilitée du test de recette.

@ConstantSIDJUI
Copy link

@supertinou est-il nécéssaire d'utiliser le formatage Markdown?

@valentinlefevre
Copy link

@christophe-lejeune un gros travail homogénéisation a été réalisé pendant le séance de ce vendredi, nous ouvrirons prochainement une issue relative à cela, elle devrait répondre à un certain nombre de problématiques posées concernant la cohérence entre les différentes fonctionnalités du projet.

@ltosi
Copy link

ltosi commented Jun 1, 2015

Si les fenêtres de consultation et d'édition sont les mêmes, nous avons besoin de deux boutons différents, l'un permettant d'enregistrer le compte-rendu courant et l'autre de créer le compte-rendu suivant.
Si les fenêtres de consultation et d'édition sont distinctes, le bouton d'enregistrement n'est nécessaire qu'en édition. Celui permettant de créer le compte-rendu suivant qu'en consultation.

Je reprends ces remarques : l'utilisateur a besoin de contexte, et un bouton d'enregistrement ne doit pas nécessiter de choix de la part de l'utilisateur, sous peine de perte de données.

Le travail fait vendredi intègre-t-il des modifications de ce côté?

@valentinlefevre
Copy link

@ltosi oui le travail effectué avec @SlaAls intègre ces remarques

@christophe-lejeune
Copy link
Member

Pourriez-vous publier dans ce ticket les maquettes mises à jour montrant :

  1. La fenêtre de consultation d'un compte-rendu, à partir de laquelle on peut créer un nouveau compte-rendu
  2. La fenêtre de modification comportant le bouton "Enregistrer" du compte-rendu courant.

@valentinlefevre
Copy link

Consulter un compte-rendu

image

Rédaction d'un compte-rendu

image

Les maquettes ci-dessus viennent du ticket d'unification, cela fait un peu doublon non?

@christophe-lejeune
Copy link
Member

L'idée n'est évidemment pas de dédoubler la discussion mais d'éventuellement la reprendre ici pour ne pas surcharger le ticket d'unification (#56).

@christophe-lejeune
Copy link
Member

Lors de notre dernière réunion, nous avons parlé d'ajouter à la fenêtre de rédaction d'un compte-rendu de terrain la possibilité de joindre des photographies. Prendre des photos des lieux fait en effet partie des pratiques de terrain en recherche qualitative.

@Slals
Copy link

Slals commented Jun 9, 2015

👍 Je pense que c'est nécessaire de discuter sur les fonctionnalités une à une via les tickets qui les correspond. La ticket unification ( #56 ) servira juste à centraliser les retouches et ajustements, ainsi que décrire les scenarii.

Lors de notre dernière réunion, nous avons parlé d'ajouter à la fenêtre de rédaction d'un compte-rendu de terrain la possibilité de joindre des photographies

Vous faites bien de le rappeler ! Une proposition sera certainement faite d'ici vendredi !

@christophe-lejeune
Copy link
Member

Dans le cas particulier du compte-rendu de terrain, il faut également prévoir le cas des transcriptions d'entretiens, qui sont structurées en tours de parole (comme c'est le cas actuellement dans Cassandre).

@valentinlefevre
Copy link

Vous faites bien de le rappeler ! Une proposition sera certainement faite d'ici vendredi !

Concernant les photographies peut-on envisager qu'elles soient intégrer au texte du compte-rendu via un simple copier-coller ou glisser-déposer?

Dans le cas particulier du compte-rendu de terrain, il faut également prévoir le cas des transcriptions d'entretiens, qui sont structurées en tours de parole (comme c'est le cas actuellement dans Cassandre).

Effectivement les maquettes ne présentent pas une configuration permettant la saisie d'un échange, peut-on se baser sur ce qui est pour l'instant proposé par Cassandre ?

@christophe-lejeune
Copy link
Member

Concernant les photographies peut-on envisager qu'elles soient intégrer au texte du compte-rendu via un simple copier-coller ou glisser-déposer?

Plus c'est simple, mieux c'est. Un glisser-déposer serait parfait.

Effectivement les maquettes ne présentent pas une configuration permettant la saisie d'un échange, peut-on se baser sur ce qui est pour l'instant proposé par Cassandre ?

Bien entendu.

Le système actuel est cependant perfectible, comme me l'ont fait récemment remarquer mes étudiants :

  • Actuellement, vu que l'ajout d'un tour de parole rafraîchit la page, l'utilisateur se retrouve en haut de page alors qu'il est en train de transcrire (en bas de page). C'est particulièrement gênant.
  • Les croix de suppression d'un tour de parole étant d'effet immédiat, il n'y est pas possibilité de revenir en arrière. Certains étudiants ont témoigné avoir dû relire l'ensemble de leur entretien après avoir cliqué par erreur sur une de ces croix.

Ces deux derniers commentaires concernent cependant peut-être moins la maquette que le comportement du formulaire.

@valentinlefevre
Copy link

Ces deux derniers commentaires concernent cependant peut-être moins la maquette que le comportement du formulaire.

Effectivement mais mieux vaut poser les choses maintenant :

  • Ajout dynamique des éléments sans rafraîchissement de page,
  • Ajout d'une étape de validation dans le processus de suppression d'un ou plusieurs tours de parole.

@AndreMarvell
Copy link

@christophe-lejeune conformément à votre retour sur le commentaire d'un membre collaborateur, voici une proposition de maquette gérant ce cas :

commentaire cr par un collaborateur 2

Comme on peut le voir, le collaborateur connecté, Olivier Ménard, peut créer un compte-rendu s'appuyant sur le compte-rendu consulté en cliquant sur le bouton dédié.

@AndreMarvell
Copy link

Conformément aux évolutions des maquettes dans l'issue #56, voici la nouvelle maquette :

commentaire cr par un collaborateur 3

christophe-lejeune added a commit that referenced this issue Jan 20, 2016
The edit button direct to a different form according to the kind of the memo.
* Field memos are edited with the form designed for the former model.
* Other types of memos are edited with the new dedicated form.
christophe-lejeune added a commit that referenced this issue May 12, 2016
* Both the comment and his/her author are saved in the memo document.
* The source document is reloaded when the comment is saved, in order to avoid to overwrite other comments (or memo edits) submitted while the user was writing down his/her own comment.
* Editing a memo (#40) follows the same principle : the original memo document (including the comments) is reloaded just before the memo is saved.
christophe-lejeune added a commit that referenced this issue May 15, 2016
* Titles are not hidden behind the top menu
* Comment button is not hidden behind the bottom menu
* Groundings panel has a fixed position
* Leaves panel has a fixed position
christophe-lejeune added a commit that referenced this issue Jul 5, 2016
Code adapted from corpus.html
christophe-lejeune added a commit that referenced this issue Jan 7, 2017
One list replaces multiple queries required to show one memo (#40), related comments (#45), its groundings preview and leaves names (#47).
@benel benel closed this as completed Jan 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests