Initialisation de la documentation de developpement.
Premiers jets de spécification. about #24 @2h, #5 @45min
This commit is contained in:
parent
595f29aad5
commit
214314f8c6
4 changed files with 231 additions and 0 deletions
|
|
@ -0,0 +1,65 @@
|
|||
# Saisie de contenu texte interprété en Markdown (Tags, FrontMatter)
|
||||
|
||||
## Courte Description
|
||||
|
||||
Interprétation du contenu au format Markdown, utilisation du FrontMatter, et des tags.
|
||||
|
||||
## Description
|
||||
|
||||
### Processus
|
||||
|
||||
``` mermaid
|
||||
flowchart TB
|
||||
Saisie[["Saisied de texte"]] --> |Représenter comme| Arbre("Un arbre noeudal MD")
|
||||
Arbre --> |Parcours les noeuds| ProchainNoeud("Noeud")
|
||||
|
||||
subgraph Analyse d'un noeud
|
||||
ProchainNoeud -->|Extraction de| Tags("Tags (#FichePratique #OutilsVisio)")
|
||||
ProchainNoeud -->|Extraire les| MetaNoeud("Métadonnées du noeud")
|
||||
ProchainNoeud -->|Extraire le | ContenuNoeud("Contenu")
|
||||
ContenuNoeud -->|Extraction d'autres| MetaNoeud("Métadonnées")
|
||||
Tags-->|Ajout au| MetaNoeud
|
||||
ContenuNoeud --> ContenuFM("ContenuMD et FrontMatter")
|
||||
MetaNoeud --> ContenuFM
|
||||
end
|
||||
subgraph Publication du noeud
|
||||
ContenuFM -->|Interpréter| Objet("Interprétations")
|
||||
Objet -->|Publier| Rendus("Versions")
|
||||
end
|
||||
```
|
||||
#### Comportements
|
||||
|
||||
```gherkin-fr
|
||||
|
||||
Fonctionnalité: …
|
||||
Dans le but de pouvoir saisir du contenu texte et de pouvoir le réutiliser
|
||||
En tant qu'utilisateurice novice ou avancé
|
||||
Je veux pouvoir écrire du Markdown via un éditeur, accéder à la source, le prévisualiser.
|
||||
Je peut aussi avoir la main sur les métadonnées du contenu (ex: FrontMatter).
|
||||
Je peut avoir un usage avancé des Tags (ou Hashtags).
|
||||
Je peut avoir un usage naturel du balisage et des métadonnées
|
||||
Je veux que la plupart de mon contenu saisi puisse être réutilisable
|
||||
Je veux donc que la plupart de mon contenu saisi puisse être analysé, interprété, rendu.
|
||||
|
||||
Règle: Saisie de contenu texte interprété en Markdown
|
||||
|
||||
Background: ~
|
||||
|
||||
Scénario: Saisie d'un contenu texte
|
||||
Étant donné un contenu 'sample.md'
|
||||
Quand le contenu est publié
|
||||
Alors il a été interprété en Markdown
|
||||
|
||||
Règle: Analyse et interprétation des tags
|
||||
|
||||
Background: ~
|
||||
|
||||
Scénario: Saisie d'un document texte avec des Tags
|
||||
Étant donné un contenu 'FichePratique-OutilsVisio.md'
|
||||
Et une métadonnée 'tags' qui contient '["DocumentMD", "OutilsVisio", "FichePratique"]'
|
||||
Quand le contenu est publié
|
||||
Alors il a été interprété en Markdown
|
||||
Et on peut le retrouver par son tag '#FichePratique'
|
||||
Et on peut le retrouver par ses tags '#FichePratique #OutilsVisio'
|
||||
```gherkin
|
||||
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
# Analysie et Interprétation des émojis
|
||||
|
||||
## Courte description
|
||||
|
||||
Je veux pouvoir utilisé des Emojis pour qualifier du contenu dans un #Sujet.
|
||||
|
||||
|
||||
## Description
|
||||
|
||||
|
||||
### Processus
|
||||
|
||||
``` mermaid
|
||||
flowchart TB
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
### Comportements
|
||||
|
||||
```gherkin-fr
|
||||
|
||||
Fonctionnalité: Analyse et interprétation des emojis et des hashtags
|
||||
Dans le but pouvoir qualifier un contenu, par exemple une 'astuce ou 'une alerte'
|
||||
En tant qu'utilisateurice qui saisie du contenu Markdown
|
||||
Je veux que lorsque ma ligne commence par l'emoji '💡 suivi d'un contenu qui contient le #Sujet'
|
||||
Je peut retrouver cette 'astuce' dans la page relative au '#Sujet'.
|
||||
Je veux aussi que mon ou mes sujets puissent être trouvé via le context
|
||||
|
||||
Règle: Interprétér l'émoji 💡 en début de ligne comme une astuce.
|
||||
|
||||
Background: ~
|
||||
|
||||
Scénario:
|
||||
Étant donné un contenu 'FichePratique-OutilsVisio.md'
|
||||
Et un contenu 'FichePratique-OutilsVisio.md'
|
||||
Quand le contenu est publié
|
||||
Alors il y a une astuce (💡) sur le tags
|
||||
|
||||
```gherkin
|
||||
|
||||
|
|
@ -0,0 +1,53 @@
|
|||
### Rédacteurice en chef
|
||||
|
||||
## Description
|
||||
|
||||
|
||||
|
||||
``` mermaid
|
||||
flowchart TB
|
||||
|
||||
|
||||
#### Configurer différentes vues (Versions) grace aux métadonnées
|
||||
|
||||
```gherkin-fr
|
||||
|
||||
Fonctionnalité: …
|
||||
Dans le but de pouvoir avoir la main sur la publication du contenus
|
||||
En tant que rédacteurice en chef
|
||||
Je veux pouvoir étendre/creer/modifier/supprimer/forcer des regles sur des inclusions ou références de contenus
|
||||
Je veux pouvoir via ces règles configurer la granularité du contenu inclus et/ou publié (ex: une courte, ou une très courte description ?)
|
||||
Je veux pouvoir via ces règles proposer d'activer/désactiver des vues (aussi appelées, versions). (ex: suggest: 'Désactiver propos sarcastiques ?', version: '@reminec')
|
||||
|
||||
|
||||
Règle: >
|
||||
|
||||
Une metadonnée "Pré-requis" peut-être ajoutée à du contenu (via 'prereqs:')
|
||||
Un contenu texte peut référencer des autres contenus
|
||||
On pensera a mettre une regle ici pour definir comment on référence pas comme des porcs
|
||||
On choisi alors si le contenu est Lier/Prévisualiser/Citer/Inclus.
|
||||
On choisi aussi son niveau de granularité
|
||||
|
||||
On espère pouvoir avoir la main sur l'analyse du contenu
|
||||
On espère avoir la main sur l'extraction de contenu
|
||||
On espère avoir la main sur le reformatage du contenu extrait
|
||||
|
||||
|
||||
Background:
|
||||
Étant donné un contenu 'FichePratique-OutilsVisio.md'
|
||||
Et une métadonnée 'tags' qui contient '["DocumentMD", "OutilsVisio", "FichePratique"]'
|
||||
|
||||
|
||||
Scénario: Référencer des pré-requis pour une FichePratique et configurer leurs affichage
|
||||
|
||||
Étant donné un contenu 'FichePratique-Jisty.md'
|
||||
Et une métadonnée 'tags' qui contient le yaml suivant '["DocumentMD", "OutilsVisio", "FichePratique", 'Jitsy']'
|
||||
Et une métadonnée qui contient le yaml suivant '[prereqs: [tags: "#OutilsVisio #FichePratique", widget: "Include", mode: "Extended", default: {collapse: true}]]'
|
||||
Quand le contenu est publié
|
||||
Alors la FichePratique-OutilsVisio.md apparait dans la section pré-requis en widget dépliable
|
||||
Alors le widget pourrait avoir en entête le nombre de minutes (ou secondes) nécessaire à lire le contenu qui peut se déplier
|
||||
Alors le widget pourrait avoir en entête le nombre d'astuces
|
||||
Alors le widget pourrait avoir en entête le nombre de recommandations d'usages
|
||||
Alors le widget devrait avoir en entête l'importance de attention que l'on devrait y consacrer
|
||||
```gherkin
|
||||
|
||||
|
|
@ -0,0 +1,71 @@
|
|||
# Utiliser les émojis
|
||||
|
||||
## Très courte description
|
||||
|
||||
Lors d'une saisie de contenu, je veux pouvoir utilisé des Emojis pour qualifier du contenu.
|
||||
|
||||
|
||||
## Courte description
|
||||
|
||||
Lorsque le premier caractère d'un noeud Markdown est un émoji, qualifier le noeud via son Emoji.
|
||||
|
||||
|
||||
## Description
|
||||
|
||||
Il faut lister les émojis et leurs correspondances.
|
||||
|
||||
|
||||
### Alternatives considérées
|
||||
|
||||
* Utiliser des émojis
|
||||
|
||||
### Élements moteur de la décision
|
||||
|
||||
* 🧲 Le besoin de typer le contenu pour pouvoir le réutiliser ensuite
|
||||
* 🧲 Le besoin d'illustrer pour faciliter la lecture en diagonale
|
||||
* 🧲 Il doit être instinctif de faire usage du bon émoji
|
||||
|
||||
|
||||
## Conclusion
|
||||
|
||||
* 📢 <UNE ANNONCE>
|
||||
* 👍 <UNE RECOMMANDATION>
|
||||
* 🙏 <UNE DEMANDE>
|
||||
* 💡 <UNE IDEE>
|
||||
|
||||
* 🤔 <UNE REFLEXION>
|
||||
* 🧐 <UN INTERET>
|
||||
* 🤓 <UNE PASSION>
|
||||
* 😎 <UNE SATISFACTION>
|
||||
* 👀 <UNE CURIOSITE>
|
||||
* 😍 <UN COUP DE COEUR>
|
||||
* 🤩 <UN COMPLIMENT>
|
||||
|
||||
* 💩 <UN DEGOUT>
|
||||
* 🧲 <UN ATTRAIT>
|
||||
|
||||
|
||||
|
||||
* ⚠️ <UNE PRECAUTION>
|
||||
* 🚨 <UNE ALERTE>
|
||||
|
||||
* ✅ <UNE VALIDATION>
|
||||
* 🚫 <UN REFUS>
|
||||
* ⚖️ <UNE DECISION>
|
||||
|
||||
* 📌 <UN PENSE-BETE>
|
||||
* 🔗 <UN LIEN AVEC ...>
|
||||
|
||||
* 🪚 <UNE TACHE A FAIRE>
|
||||
* 🚧 <UN CHANTIER EN COUR OU A ORGANISER>
|
||||
|
||||
* 🧳 <UN DEPLACEMENT>
|
||||
* 📅 <UN RDV DE FIXE>
|
||||
* 🗺️ <UN ENDROIT>
|
||||
* 👥 <UNE RENCONTRE>
|
||||
|
||||
* 🧪 <UNE EXPERIENCE>
|
||||
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in a new issue