Décrire l'objectif du métascript, sa justification, les bénéfices, les limitations. Indiquer l'environnement approprié et quand l'utilisation de ce métascript est appropriée ou non.
[Optionel] Décrire la raison première qui a motivé la création du métascript et éventuellement du script.
Décrire sommairement l'activité réglée par le métascript, les divers arguments et le ou les résultats.
Liste et description sommaires chaque variante. Voici deux exemples:
Liste et description sommaires de chaque objet étiqueté. Un exemple:
Description des objets non étiquetés. Un exemple:
Chaque objet non étiqueté, identifié comme "Phrase" contient un fragment de texte non validé qui sera modifié puis utilisé comme nom de fichier.
Est-ce que le presse-papiers est utilisé, et comment. Un exemple:
Le presse-papiers n'est pas utilisée comme argument sous aucun variante. Toutefois, son contenu est modifié à la fin de l'activité du script; il contient le nom complet d'un fichier.
Les messages associés au code exit du script ou commande. Un exemple:
Un exemple: La commande "Vider la liste" est requise avant de réutiliser le métascript.
Un exemple:
Sous la variante Création, le script crée un nouveau fichier à partir de l'objet non étiqueté courant "texte" sous le répertoire identifié par l'objet étiqueté "Rép Dest".
Voir aussi les sections Objectif et Description en haut.
Vous n'avez pas à décrire comment lancer D&Do ni comment charger ce métascript.
Commencer la description comme si D&Do est déjà lancé et chargé avec ce métascript avec la variante par défaut.
Vous assumez que la section Description a été lue, concentrez sur le comment accomplir une tâche spécifique en expliquant chaque étape. Décrire les problèmes éventuels et expliquer les moyens d'y remédier.
Organizez ce guide soit par tâche (qui peut inclure plusieurs variantes) ou soit par chaque variante possible.
Commencez plar la liste des tâches ou variantes
Ajoutez les auteurs et propriétaires de chaque version.