Merge pull request 'features/docs' (#25) from features/docs into develop
Reviewed-on: #25
This commit is contained in:
commit
374d997ddd
|
|
@ -0,0 +1,118 @@
|
|||
# [UN MARQUEUR 1] UN TITRE 1
|
||||
|
||||
## Date & lieu
|
||||
|
||||
* 📅 UNE DATE
|
||||
* 🔗 UN LIEN DE SONDAGE
|
||||
* 🗺️ UN LIEU
|
||||
* 🔗 UN LIEN DE CARTE OU D'OUTIL DE VISIO
|
||||
|
||||
|
||||
## Courte description
|
||||
|
||||
UNE COURTE DESCRIPTION 1
|
||||
|
||||
|
||||
## Participant⋅es
|
||||
|
||||
* ✅ UNE PARTICIPANTE 1
|
||||
* ✅ UN PARTICIPANT 2
|
||||
|
||||
* 🚫 UN ABSENT 1
|
||||
|
||||
|
||||
### Animation / Scribe
|
||||
* 🗣️ UNE PARTICIPANTE 1
|
||||
* 📝 UN PARTICIPANT 2
|
||||
|
||||
|
||||
### Convié⋅es
|
||||
* 💺 UNE CONVIEE 1
|
||||
* 💺 UN CONVIE 2
|
||||
|
||||
|
||||
### Invité⋅es
|
||||
* 🤔 UNE INVITEE 1
|
||||
* 🤔 UN INVITE 2
|
||||
|
||||
|
||||
## Ordre Du Jour (ODJ)
|
||||
|
||||
* 👋 Présentation / Tour de table | 🕑 0-10min
|
||||
* 📌 UN ODJ Obligatoire 1 | 🕑 UN TEMPS ESTIME 1
|
||||
* 🎈 UN ODJ Optionnel 1 | 🕑 UN TEMPS ESTIME 2
|
||||
* 👋 Conclusion / Tour de table | 🕑 0-10min
|
||||
|
||||
|
||||
## Description
|
||||
|
||||
### Annonces
|
||||
|
||||
* 📢 UNE ANNONCE 1
|
||||
* ⚠️ UNE PRECAUTION 1
|
||||
* 🚨 UNE ALERTE 1
|
||||
|
||||
* ✅ UNE TACHE OU DECISION VALIDEE 1
|
||||
* 🚫 UNE TACHE OU DECISION ANNULEE 1
|
||||
|
||||
* ⚖️ UNE DECISION A PRENDRE 1
|
||||
* ❓ UNE QUESTION 1
|
||||
* 📌 UNE TACHE A FAIRE 1
|
||||
* 🚧 UN CHANTIER EN COUR OU A ORGANISER 1
|
||||
|
||||
* 🧳 UN DEPLACEMENT 1
|
||||
* 📅 UN RDV DE FIXE 1
|
||||
|
||||
|
||||
### Feuille de route | ~DATE PROCHAIN RDV
|
||||
|
||||
### Tour de table
|
||||
|
||||
#### 👋 UNE PARTICIPANTE 1
|
||||
|
||||
UN TEXTE 1
|
||||
|
||||
|
||||
#### 👋 UN PARTICIPANT 2
|
||||
|
||||
UN TEXTE 2
|
||||
|
||||
|
||||
### 📝 UN SUJET 1
|
||||
|
||||
DES NOTES 1
|
||||
|
||||
|
||||
### 📝 UN ODJ Obligatoire 1
|
||||
|
||||
DES NOTES 2
|
||||
|
||||
|
||||
### 📝UN ODJ Optionnel 1
|
||||
|
||||
DES NOTES 3
|
||||
|
||||
|
||||
### 📝 UN TRUC PAS PREVU 1
|
||||
|
||||
DES NOTES 4
|
||||
|
||||
|
||||
## FAQs
|
||||
|
||||
### ❓ UNE QUESTION 1
|
||||
|
||||
UNE REPONSE 1
|
||||
|
||||
|
||||
## Versions
|
||||
|
||||
### v0.0.2
|
||||
_date: 00 janvier 0000 | Auteurice2_
|
||||
* Travail 2
|
||||
* Travail 3
|
||||
|
||||
### v0.0.1
|
||||
_date: 00 janvier 0000 | Auteurice1, Auteurice2_
|
||||
* Travail 1
|
||||
|
||||
|
|
@ -0,0 +1,71 @@
|
|||
# <UN TITRE ICI>
|
||||
|
||||
## Très courte description
|
||||
|
||||
<UNE PHRASE ICI>
|
||||
|
||||
|
||||
## Courte description
|
||||
|
||||
<QUELQUES PHRASES ICI (optionel)>
|
||||
|
||||
|
||||
## Description
|
||||
|
||||
<QUELQUES PHRASES ICI (optionel)>
|
||||
|
||||
|
||||
### Alternatives considérées
|
||||
|
||||
* 👀 <ALTERNATIVE 1>
|
||||
* 👀 <ALTERNATIVE 2>
|
||||
* 👀 <ALTERNATIVE 3>
|
||||
|
||||
|
||||
### Élements moteur de la décision
|
||||
|
||||
* 🧲 <BESOIN 1>
|
||||
* 🧲 <BESOIN 2>
|
||||
* 🧲 <BESOIN 3>
|
||||
|
||||
|
||||
## Conclusion
|
||||
|
||||
* ✅ **<ALTERNATIVE RETENUE 1>**
|
||||
* 🤔 **<ALTERNATIVE EVENTUELLE 2 >**
|
||||
|
||||
|
||||
### Conséquences
|
||||
|
||||
* 👍 <CONSEQUENCE POSITIVE 1>
|
||||
* 👍 <CONSEQUENCE POSITIVE 2>
|
||||
|
||||
* 👎 <CONSEQUENCE NEGATIVE 1>
|
||||
|
||||
|
||||
### Comparaison (Optionel)
|
||||
|
||||
#### <ALTERNATIVE 1>
|
||||
|
||||
* 👍 <ARGUMENT 1 PRO>
|
||||
* 👍 <ARGUMENT 2 PRO>
|
||||
* 👎 <ARGUMENT 1 CONTRA>
|
||||
|
||||
|
||||
#### <ALTERNATIVE 2>
|
||||
|
||||
* 👍 <ARGUMENT 1 PRO>
|
||||
* 👍 <ARGUMENT 2 PRO>
|
||||
* 👎 <ARGUMENT 1 CONTRA>
|
||||
|
||||
|
||||
#### <ALTERNATIVE 3>
|
||||
|
||||
* 👍 <ARGUMENT 1 PRO>
|
||||
* 👍 <ARGUMENT 2 PRO>
|
||||
* 👎 <ARGUMENT 1 CONTRA>
|
||||
|
||||
## Aller plus loin
|
||||
|
||||
* 🧐 <RESOURCE 1>
|
||||
* 🧐 <RESOURCE 2>
|
||||
|
|
@ -0,0 +1,85 @@
|
|||
# Prendre et documenter des décisions
|
||||
|
||||
## Très courte description
|
||||
|
||||
**Patron de conception** afin de **documenter et justifiés les choix**, par exemple les **choix d'architectures** (**ADR**) dans l'industrie logiciels.
|
||||
|
||||
|
||||
## Courte description
|
||||
|
||||
Il existe un patron de conception qui s'applique aux décisions architecturales, [ADR](https://adr.github.io/).
|
||||
|
||||
Ce patron peut-être **étendu à tout types de décisions**.
|
||||
|
||||
|
||||
## Par où commencer ?
|
||||
|
||||
Voir le modèle proposé ici [_resources/model-decision.md](./_resources/modele-decision.md)
|
||||
|
||||
|
||||
## Description
|
||||
|
||||
Les décisions ont besoins d'être **réfléchies** et **documentées**.
|
||||
|
||||
Les resources ci-dessous proposent des guides et exemples d'implémentations.
|
||||
|
||||
* [Markdown (ADR)](ADRhttps://adr.github.io/madr/) | _propose des modèles et outils pour maintenir une liste de décisions en Markdown_
|
||||
* [Saisie de décision](https://schubmat.github.io/DecisionCapture/) | _encore des modèles_
|
||||
|
||||
|
||||
#### Définition
|
||||
##### **Architectural decision (AD)** _Décision architecturale_
|
||||
|
||||
**Choix justifié qui répond à une exigence** fonctionnelle ou non fonctionnelle **significative** sur le plan architectural.
|
||||
|
||||
Les **décisions d'architecture** répondent à des **exigences importantes** ; elles sont perçues comme **difficiles à prendre** et/ou **coûteuses à modifier**.
|
||||
|
||||
|
||||
##### Architecturally Significant Requirement (ASR)
|
||||
|
||||
Les **exigences architecturallement significatives** sont celles qui ont un effet **mesurable** sur l'architecture.
|
||||
|
||||
Il s'agit d'**un sous-ensemble d'exigences**, le sous-ensemble qui affecte l'architecture d'un système de **manière mesurable** et **identifiable**.
|
||||
|
||||
|
||||
## En savoir plus
|
||||
|
||||
* **ADR**: https://adr.github.io/
|
||||
* **Saisie de Décision**: https://schubmat.github.io/DecisionCapture/
|
||||
|
||||
|
||||
### Voir aussi
|
||||
|
||||
##### Exemples
|
||||
* https://forge.liiib.re/libre.sh/libre.sh/-/tree/develop/docs
|
||||
|
||||
|
||||
## License
|
||||
|
||||
[CC BY-SA 2.0 FR](https://creativecommons.org/licenses/by-sa/2.0/fr/)
|
||||
|
||||
### Autheurices
|
||||
* grincheuxx
|
||||
* reminec @ acides.org (Tedomum.net)
|
||||
|
||||
_Librement traduit depuis adr.github.io_
|
||||
|
||||
## Versions
|
||||
### v0.1.0
|
||||
_Date : 26 mars 2023 | Temps rédaction : 25min_ | reminec
|
||||
* Reformatage
|
||||
* Editions
|
||||
* Ne concerne plus que les ADR mais toutes les décisions
|
||||
|
||||
### v0.0.2
|
||||
_Date : 17 mars 2023 | Temps rédaction : 30min_ | reminec
|
||||
* Reformatage
|
||||
* Editions
|
||||
|
||||
### v0.0.1
|
||||
_Date : 17 mars 2023 | Temps rédaction : 30min_ | reminec, grincheuxx
|
||||
* Introduction à l'ADR par 2 novices sans experts
|
||||
|
||||
## Remerciements
|
||||
|
||||
* [PierreO.](https://mastodon.indie.host/@pierreozoux) @ [indiehosters.net](https://indiehosters.net) - Pour avoir soufflé ce patron de conception
|
||||
298
data/pages/index.md
Normal file
298
data/pages/index.md
Normal file
|
|
@ -0,0 +1,298 @@
|
|||
# ACIDES/hlilo 🧪 Labo ACIDES.org 🏴☠️🌈 Tedomum.net
|
||||
|
||||
[TOC]
|
||||
|
||||
## Très courte Description
|
||||
|
||||
**H**yper **L**ost **I**n **L**earning, **O**verview. | 🧪 Labo de culture contributives
|
||||
|
||||
> Traduction en français : _Complètement perdu dans l'apprentissage, vue d'ensemble._
|
||||
|
||||
|
||||
## Courte Description
|
||||
|
||||
`ACIDES/hlilo` est une **initiative pour tenter de faciliter la croisée entre l'apprentissage et la pratique**.
|
||||
|
||||
Des **#Ateliers** plus ou moins prévu à l'avance ; sur des **#Projets** libre.
|
||||
|
||||
C'est pour l'instant un **endroit** où quelques **zinzins contribuent ensemble** ;
|
||||
Ça pourrait aussi être un **bidule culturel** où l'on essaye de **fabriquer** des trucs.
|
||||
|
||||
De ce fait, on va **réviser son anglais**, en tentant de **poser du français** dessus.
|
||||
|
||||
## Description
|
||||
|
||||
Dans les _vagues motivations_ qui trottent dans `ACIDES/hlilo` on y trouve l'**envie** d'**apprendre**, **pratiquer** et **contribuer** à des **projets** existants(🐈) ou à imaginer(🏴☠️🌈).
|
||||
|
||||
Par **convergences d'affinités, de besoins, d'envies**, les membres **se retrouvent au sein d'#Ateliers**.
|
||||
|
||||
|
||||
On distingue 2 **familles** d'**#Ateliers** :
|
||||
* Les **#AtelierSauvage** un peu tout le temps (Voir [Fonctionnement](#Fonctionnement))
|
||||
* Les **#AtelierATheme** sont _+/-_ **plannifiés en avance** afin d'être **annoncé**.
|
||||
|
||||
``` mermaid
|
||||
flowchart TD
|
||||
Occupe[Déjà occupé ?] -->|Oui| PlusTard[On s'voit plus tard]
|
||||
Occupe -->|Non| AtelierEnCour[#Ateliers en cours ?]
|
||||
AtelierEnCour -->|Oui| Interesse[Intéressé par l'#Ateliers ?]
|
||||
Interesse -->|Oui| Rejoins[Rejoins l'#Ateliers]
|
||||
Interesse -->|Non| idee[Ouvre un #Ateliers]
|
||||
AtelierEnCour -->|Non| idee[Une idée ?]
|
||||
|
||||
idee -->|Pas d'idée| ideeNon[Demande à l'agent #AtelierSVP]
|
||||
idee -->|Tout à fait| Atelier[Ouvre un #Ateliers]
|
||||
ideeNon -->Rejoins
|
||||
Atelier -->Rejoins
|
||||
```
|
||||
|
||||
### Comment se déroule les #Ateliers ?
|
||||
|
||||
Voir la section dans [Description](#Description)/[Fonctionnement](#Fonctionnement)/[Les Ateliers](#Les%20Ateliers).
|
||||
|
||||
## Par où commencer ?
|
||||
|
||||
_**C'est encore l'binz ici 😬**._
|
||||
|
||||
0. L'idée est pour le moment **rejoindre l'espace Matrix [#acides-hilo:tedomum.net](https://matrix.to/#/#acides-hlilo:tedomum.net)** et les **salons recommandés**
|
||||
1. Vous arrivez depuis l'espace CryptPad(😍) ?
|
||||
* 🔗 _Bientôt un guide pour rejoindre Matrix_
|
||||
* #Ateliers prévu semaine 14 pour l'écrire (https://framadate.org/EHioQxwDwwSrxopR)
|
||||
|
||||
|
||||
Si vous voulez **comprendre le sens** de tout ça, le mieux est encore de lire **les sections [Description](#Description)/[Fonctionnement](#Fonctionnement)**.
|
||||
|
||||
|
||||
_Bientôt a priori, un groupe mobilizon pour les #AteliersATheme_
|
||||
|
||||
|
||||
En attendant, on tâche d'être exhaustif dans les sections **Feuilles de routes** et **Liste des tâches** ci-dessous 👇
|
||||
|
||||
|
||||
### Feuille de route
|
||||
|
||||
[Feuille de route](https://git.deuxfleurs.fr/ACIDES-hlilo/hlilo-website/milestones) pour mettre en place le bouzin.
|
||||
|
||||
|
||||
### Liste des tâches
|
||||
|
||||
* Tableaux
|
||||
* Par projets
|
||||
* Pour `#ACIDEShliloWebsite`
|
||||
* [le tableau sur la forge](https://git.deuxfleurs.fr/ACIDES-hlilo/hlilo-website/projects/13)
|
||||
* sur l'instance cryptpad(😍) | [Le tableau à la racine du disque](https://pad.deuxfleurs.fr/kanban/#/2/kanban/view/WBOQHX3e+HbMb6FZzv0CPf4eBRcR5+l-0NR7CGEl3RE/)
|
||||
* Pour `#Offlure2023Website`
|
||||
* [Le tableau sur la forge](https://git.deuxfleurs.fr/reminec/offlure2023-website/projects/11)
|
||||
* Bientôt sur cryptpad(😍)
|
||||
* Nouveautés
|
||||
* [Sur la forge logiciel gitea](https://git.deuxfleurs.fr/ACIDES-hlilo/hlilo-website/activity)
|
||||
* [Sur l'espace Matrix](https://matrix.to/#/#acides-hlilo:tedomum.net) salon ACIDES::hlilo::Journaux
|
||||
* Moins à jours (La [liste des nouveautés](https://pad.deuxfleurs.fr/code/#/2/code/view/RPoLWljPwpHKusdq8zsLL3b17pqgglFVxvX2e6G1k48/) de l'espace de travail)
|
||||
|
||||
|
||||
### La trousse à outils
|
||||
|
||||
##### Cryptpad(😍)
|
||||
|
||||
Outil pour **collaborer à plusieurs** et **en même temps** sur :
|
||||
* Des saisis de **#DocumentMD** (Comme celui-ci)
|
||||
* Des **#Formulaires**
|
||||
* Des **#Tableaux**
|
||||
* ...
|
||||
|
||||
###### Astuces
|
||||
|
||||
* 💡 Cryptpad(😍) permet entre autre de **📷 Capturer** une `versions` pour en garder l'**Historique**.
|
||||
* 💡 Pour écrire sur un **#DocumentMD** au format `.md` (Markdown) sur Cryptpad(😍), vous devez selectionner **Nouveau** -> **Code**.
|
||||
|
||||
|
||||
##### Gitea - Forge logiciel
|
||||
|
||||
Outil pour **construire** et **publier** une `base de connaissance`.
|
||||
|
||||
|
||||
##### Un agent
|
||||
|
||||
Qu'on ressucite ```Clippy```, ou qu'on le croise sur un salon Matrix, cet `agent 🤖` vous accompagnera dans l'animation des #Ateliers.
|
||||
|
||||
|
||||
### Fonctionnement
|
||||
|
||||
#### Publication sur une `base de connaissance`
|
||||
|
||||
``` mermaid
|
||||
flowchart TD
|
||||
P[Outil pour créer/éditer/collaborer à plusieurs sur du contenu ?] --> F
|
||||
F[Utiliser Cryptpad] -->|Utilisé pour prises de notes, etc | Version1{Fichiers >=v1.0.0 ?}
|
||||
F -->|Pas utilisé| FNon[Pourquoi ?]
|
||||
Version1 -->|Oui| Version1Oui[Demande de fusion dans la forge numérique]
|
||||
Version1 -->|Non| Version1Non[Capture v.0.x.y]
|
||||
Version1Non -->|Tant que| Version1
|
||||
Version1Oui -->Demande{Relecture et appréciation}
|
||||
Demande -->|Corrections si nécessaire|Demande
|
||||
Demande -->|Validation|End[Publication dans une base de connaissance]
|
||||
```
|
||||
|
||||
#### Les Ateliers
|
||||
|
||||
Des **#Ateliers** sont _+/-_ **organisés** ; _a peu près_ **n'importe quand**, à priori **en distanciel**, avec l'aide d'un ~~concierge~~ `agent 🤖` :
|
||||
* Une sorte d'**animateur**
|
||||
* ⏰ Organise des pauses, les annonces.
|
||||
* ⌚ Permets à celles et ceux qui souhaitent de rejoindre/continuer à la reprise de l'#Ateliers
|
||||
* 💡 _Moment **usuellement recommandé** pour **accueillir/présenter/rejoindre** les **#Ateliers**_
|
||||
* 🚸 _La maman ci-dessous 👇 permet de gérer le raffus dans les couloirs_
|
||||
* Aussi maman/**animatrice**
|
||||
* **Presente les projets**
|
||||
* 📎🗄️ _Aide à retrouver où on a perdu la liste des trucs à faire_
|
||||
* **Presente les #Ateliers**
|
||||
* 📝✂️ _Distribue crayons et ciseaux pour **copier/coller**, si jamais..._
|
||||
* **T'accompagne dans les #Ateliers**
|
||||
* 🫢🕰️ _Peut faire un mot d'excuse si t'as raté le début_
|
||||
* Faiseureuse de joyeuses rencontres
|
||||
* 👨❤️👨 **Presente et accueil les membres**
|
||||
* 🔀 Essaye de **faciliter** les **#AtelierSauvage** ou la prévision/communication d'**#AtelierATheme**
|
||||
* 📅 _prends des #RDV ~~chez le dentiste~~ pour les **#AtelierATheme**_
|
||||
* Et si **rencontre tendue** ?
|
||||
* `!hocto `(gone) 🤼
|
||||
|
||||
|
||||
##### 👩💼📝 #Ateliers de Documentation croisée | #AtelierDocCroisee
|
||||
|
||||
> La **documentation croisée** est un format dans lequel un “**expert**” instruit un “**novice**” qui en échange **produit une recette** sous licence libre.
|
||||
> #### Pourquoi faire ?
|
||||
> **Transmettre et documenter des savoirs** en même temps
|
||||
|
||||
_Source : https://www.metacartes.cc/faire-ensemble/recettes/documentation-croisee/_
|
||||
|
||||
``` mermaid
|
||||
flowchart TD
|
||||
Atelier[Atelier] -->F{Saisie et formattage de contenu}
|
||||
F -->|Partager le contenu| Publication[Processus de Publication]
|
||||
F -->|Pas de contenu| FNon[Ce n'est pas un #AtelierDocCroisee]
|
||||
```
|
||||
|
||||
|
||||
##### 🪚📐 #Ateliers de pratique | #AtelierPratique
|
||||
|
||||
On tente de faire avec ce qu'on sait 🤔; ou presque 🤨.
|
||||
|
||||
Aussi, on fait des **#DocumentMD** et on essaye de les **publier**.
|
||||
|
||||
|
||||
##### 📡🛸 #Ateliers de découverte | #AtelierDecouverte
|
||||
|
||||
On tente de comprendre ce qu'on fait 🤯 ; tout en ne comprenant pas ce qu'on lit 🧐 ~~en anglais~~.
|
||||
|
||||
Aussi, on fait des **#DocumentMD** et on essaye de les **publier**.
|
||||
|
||||
|
||||
##### 🤕🚑 #Ateliers de dépannage | #AtelierDepannage
|
||||
|
||||
On tente de dépatouiller des membres en galère 😤 ;
|
||||
|
||||
En échange le/la dépatouillue r'mets au propre sa problématique et la solution, si elle existe.
|
||||
|
||||
``` mermaid
|
||||
flowchart TD
|
||||
Atelier[Atelier] -->F{Saisie et formatage de la Question/Reponse}
|
||||
F -->Publication[Processus de publication]
|
||||
F -->|Pas de saisie| FNon[Ce n'est pas un #AtelierDepannage]
|
||||
```
|
||||
|
||||
##### ⌨️🖥️ #AtelierJAM
|
||||
Vous situez des ~~_punks_~~ zicos _~~qui n's'arrêtent jamais~~_ en apéro avec des instruments ? 🎸🥁🍻
|
||||
|
||||
La même chose derrière un clavier pour faire des trucs. ⌨️
|
||||
|
||||
|
||||
##### 🖱️🎮 #AtelierJeux - Atelier Jeux
|
||||
|
||||
Vous situez des zicos _~~qui n's'arrêtent toujours pas~~_ en apéro avec des instruments ? 🗣️🍻🍻🥁
|
||||
|
||||
La même chose derrière clavier/souris/manette. ⌨️🖱️🎮
|
||||
|
||||
##### Historique
|
||||
|
||||
> * En hommage à une Dj `Lost In House` pour ses [télé-diffusion depuis son salon](https://www.twitch.tv/lost_in_house) _et en chaussette_
|
||||
> * En hommage à un collectif `Lost in médiation` constitué de chercheureuse et travailleureuse pour leurs publications
|
||||
* Comme celle ci : [Où est donc passée la culture numérique ?](https://framablog.org/2023/03/16/ou-est-donc-passee-la-culture-numerique/)
|
||||
|
||||
Dans la vague idée d'un endroit pour saisir du contenus et des lignes de codes.
|
||||
|
||||
|
||||
#### Règles du jeu
|
||||
|
||||
Le respect des personnes, des divergences, est requis.
|
||||
|
||||
##### Les Licences pour les contenus
|
||||
|
||||
Les contenus présents ici sont placés sous la licence ```CC-BY-SA```.
|
||||
|
||||
License contagieuse qui permet la libre réutilisation (potentiellement commerciale) desdits contenus.
|
||||
|
||||
Les codes sources devrait, à priori, être publié sous la license `AGPLv3+` (voir sur la forge logiciel).
|
||||
|
||||
|
||||
##### Versions
|
||||
|
||||
Merci de tendre au mieux vers un versionnement du type ```v1.2.3```
|
||||
1. Ajout/Corrections majeur
|
||||
2. Ajout/Corrections moyennement majeur
|
||||
3. Ajout/Corrections mineur
|
||||
|
||||
* Cryptad(😍) gère les 📷 **captures** (snapshots) `v0.1.2`
|
||||
* Git pour le reste.
|
||||
|
||||
|
||||
### FAQ
|
||||
###### Pourquoi un 'Disque' sur cryptad(😍) plutôt qu'une forge de logiciel ?
|
||||
|
||||
Dans l'idée d'accueillir des personnes utilisateurices d'outils numérique mais non qualifiées pour s'intégrer dans une forge de logiciel.
|
||||
|
||||
Une sorte d'accueil avant d'arriver à rejoindre l'espace Matrix.
|
||||
|
||||
Aussi, c'est un merveilleux outil pour commencer à s'organiser et partager.
|
||||
|
||||
On verra le reste ensuite...
|
||||
|
||||
|
||||
###### Pourquoi le contenu est en français ?
|
||||
|
||||
Approcher et intégrer une notion ou un savoir est déjà difficile en soit.
|
||||
La **gymnastique** intellectuelle **requise** par l'utilisation d'une **langue non-maternelle** peut-être un **frein** dans les **chemins d'aprrentissage**.
|
||||
|
||||
Aussi, **reformuler une explication** depuis la vue 'novice' est un **exercice** qui participe à l'**aquisition du savoir** ou de la **notion**.
|
||||
|
||||
|
||||
### En savoir plus
|
||||
* [Diataxis.fr](https://diataxis.fr) propose un cadre de travail pour la rédaction de la documentation technique.
|
||||
* Jean-Michel Cornu - [chaîne sur la coopération et l'animation de groupes et de communautés qui présente en particulier les "trucs d'animation"](https://www.youtube.com/c/jmichelcornu)
|
||||
|
||||
|
||||
## License
|
||||
|
||||
[CC BY-SA 2.0 FR](https://creativecommons.org/licenses/by-sa/2.0/fr/)
|
||||
|
||||
## Credits
|
||||
|
||||
### Auteurices
|
||||
* reminec 🤪 | 🧪 ACIDES.org 🏴☠️🌈 Tedomum.net
|
||||
* (v0.x) grincheuxx
|
||||
|
||||
|
||||
### Relectures
|
||||
|
||||
* Trollune
|
||||
* Grincheuxx
|
||||
|
||||
|
||||
### Soutient
|
||||
|
||||
* tedomum.net
|
||||
* deuxfleurs.fr (instance git et cryptpad)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -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