1
0
mirror of https://gitlab.com/free_zed/free_zed.gitlab.io.git synced 2024-06-01 22:02:28 +00:00

Add documentation pour arts numeriques notes

This commit is contained in:
Freezed 2023-02-19 11:30:41 +01:00 committed by freezed
parent ba379e02d6
commit 1ec463dcb2

View File

@ -0,0 +1,62 @@
Title: Documentation, logiciel libre et pérennité en arts numériques
Date: 2023-02-19 11:01
Summary: SUMMARY
Category: Bloc-notes
Tags: live-notes, pyconfr, talk, bordeaux, python, documentation, logiciel-libre
Status: published
Par **[Édith Viau][author]** - Salle [Thomas Edison][tedison]
### [Documentation, logiciel libre et pérennité en arts numériques][abstract]
[![logo PyConFr Bordeaux 2023][pyconimg]][pyconfr]
> Les arts numériques posent des défis de conservation et de préservation importants, de par leurs contraintes matérielles et logicielles.
>
> Une utilisation judicieuse de composantes sous licence libre peut favoriser la pérennité des oeuvres réalisées avec les technologies modernes.
>
> Une documentation technique adéquate constitue un facteur de succès important pour un tel projet. Voici quelques réflexions sur le sujet ainsi que des lignes directrices pour vous guider, basés sur notre expérience avec Sphinx, le logiciel utilisé pour la documentation de Python, au Metalab, le laboratoire de recherche et développement de la Société des arts technologiques (Montréal, Québec, Canada).
_[Support][support]_
---
Notes personnelles
==================
* presentation
- contributrice traduction python
- responsable documentation au [Metalab de la Société des Arts Technologique (SAT)](https://sat.qc.ca/en/metalab)
* Comment commencer une doc
- pratique: on part de la matière et
- technique
- pour les AN
- il faut choisir (tentative d'épuisement d'un lieu pParisien G Perec 1975)
* Qu'est ce qui est important?
- documentation vs. interface: machine Antycithère
- essentiel: le pourquoi et le quoi
- conseils doc utile sans être complète
* écrire pour soi: ce que j'aurai aimé quand j'ai commencé
- `sphinx-quickstart`
* documenter celon le cas d'usage
- guide de refence ou tuto?
- Hello world ou exemple complexe?
- utilisateur débutant ou confirmé
- spécificité des AN: des artistes en résidences
* éditer pour les autres
- évaluer rapidement l'outil
- comment il s'imbrique avec les outils existant'
- tuto et démo pour artistes
* Pourquoi documenter lorsque l'on fait le dev?
- améliorer l'existant
- clarifier ses idées
* On documente quoi?
[abstract]: https://www.pycon.fr/2023/fr/talks/1h.html#documentation-logiciel-libre-e
[author]: https://codame.com/artists/edith-viau
[hpoincare]: https://fr.wikipedia.org/wiki/Henri_Poincaré
[pyconfr]: https://www.pycon.fr/2023/
[pyconimg]: {static}/img/200-pycon-fr-23.png
[support]: https://