Utilisateur:Linarphy/bac à sable

Création de documentation de script automatisé[modifier | modifier le wikicode]

Objectifs[modifier | modifier le wikicode]

Documenter, décrire et expliquer un script ou une commande, en utilisant une procédure, un logiciel ou un autre script déjà documenté
Être simple à construire
Être simple à lire
Être joli

Méthodes[modifier | modifier le wikicode]

Modèle par opération[modifier | modifier le wikicode]

À chaque opération, lui associer un modèle qui doit être appelé avec les arguments pour écrire la commande avec les bons arguments et la documentation associé, et un lien vers la section d'une page liée à cette commande.

Note
nom	score
simplicité à développer	1
simplicité à utiliser	8
ergonomie	x
joli	x
total	4.5

Module par opération[modifier | modifier le wikicode]

À chaque opération, lui associer un module qui doit être appelé avec les arguments pour écrire la commande avec les bons arguments et la documentation associée, et un lien vers la section d'une page liée à cette commande.

Note
nom	score
simplicité à développer	4
simplicité à utiliser	8
ergonomie	x
joli	x
total	6

Module par page[modifier | modifier le wikicode]

À chaque documentation de logiciel, lui associer un modèle qui doit être appelé avec les arguments pour écrire la bonne commande, avec les bons arguments et la documentation associée, et un lien vers la section d'une page liée à cette commande.

Note
nom	score
simplicité à développer	6
simplicité à utiliser	7
ergonomie	x
joli	x
total	6.5

Un seul module[modifier | modifier le wikicode]

Écrire un seul module, qui comprend les pages pour créer la commande et la documentation associé si on lui passe le lien vers la section associé à la procédure. Ce qui nécessite aussi d'avoir une documentation de processus normé (modèle/module associée à une procédure ?)


nom	score
simplicité à développer	4
simplicité à utiliser	9
ergonomie	x
joli	x
total	6.5

cat {file}