1
0
mirror of https://gitlab.com/free_zed/free_zed.gitlab.io.git synced 2024-06-08 23:42:37 +00:00

💬 Update documentation pour arts numeriques notes

This commit is contained in:
Freezed 2023-02-19 12:02:33 +01:00
parent ad6d095650
commit 3d7acd444a

View File

@ -52,6 +52,34 @@ Notes personnelles
- améliorer l'existant
- clarifier ses idées
* On documente quoi?
- la carte ou le territoire?
- ennoncé les choix arbitraires des choix motivés
- garder le lien avec les communautés
* Exemple #1 [`splash`](http://sat-metalab.gitlab.io/splash/doxygen/index.html)
- minimiser les prérequis: avoir un objet modélisable disponible partout?
* cube: objet simple mais peu de personne en ont a dspo
* un coin de mur! tout le monde en a un et on peut joindre un modèle 3D dans la doc que tout le monde pourra utiliser
* construire sur les acquis: on commence avec un projecteur, plus de projecteurs dans des étapes suivantes
* REX
* Exemple #2 [`LivePose`](https://gitlab.com/sat-mtl/tools/livepose): ML pour AN
- besoin de communiquer avec d'autres outils
- rédiger un liens JS
* **Conclusion:** comment faire une doc utile sans être complète
- ce que l'on fait
- pourquoi on le fait'
- ce qui n'est pas dans le code (carte vs. territoire)
* Références
- Blender docs: pair documenting
- Diàtaxis: architecture de la documentation
- [How to make sense of any mess](https://www.youtube.com/watch?v=s6lXWgnTmRE): Quand on a beaucoup de doc à (re)structurer…
- Write the Docs
- Rédaction technique en information - UdeSherbrooke
- Rafael Lozano-Hemmer: Best practices for conservation of media arts texte - (vidéo est à voir)
- Doc Sphinx
* Questinos:
- intéret de git: oui mais peut-être plus encore de la CI
- test s'assurant que l'outil n'a pas été mis a jour sans la doc: non, mais c'est un sujet en discussion dans la communauté Read the docs
- mesurer si les utilisateurs ont été perdu ou gagné? Collecte de retour utilisateurs multi-canaux
[abstract]: https://www.pycon.fr/2023/fr/talks/1h.html#documentation-logiciel-libre-e