Swad

Swad est l'acronyme de Scenari Workspace & Application Documentation .

Swad permet de créer les documents d'aide destiné à l'utilisateur d'une chaîne éditoriale Scenari :

• site d'aide embarquée dans la SCENARIapp, accessible depuis le menu ? ;
• site d'aide externe à l'application, diffusé en ligne ou sur CDRom ;
• la documentation papier ;
• l'écran d'accueil SCENARIapp ;
• la présentation de l'atelier (visible lorsqu'on sélectionne la racine d'un atelier dans l'interface Scenari), souvent sous forme d'onglets.

La structure du modèle documentaire s'appuie sur trois types d'items métiers remarquables :

• les procédures pour la description étape par étape d'actions utilisateur à mener dans le logiciel, illustrées ou non de copies d'écran et vidéos d'écran ;
• les concepts et définitions pour poser et décrire le vocabulaire technique et métier utilisé dans le logiciel documenté  ;
• les écrans, descriptions d'écrans, de boutons, menus pour détailler l'interface utilisateur.

Swad met à disposition des fonctions spécifiques nécessaires à la documentation de Scenari :

• balises dans le texte spécifiques facilitant l'écriture : bouton textuel, case à cocher, bouton radio, chemin de menu, chemin d'un fichier, label, icône ou partie d'écran, balise ;
• gestion différenciée des images d'illustration et des copies d'écran du logiciel ;
• publication du site embarqué sans sur-fenêtre compatible avec une SCENARIapp ;
• gestion des aides contextuelles dédiées à Scenari : écran d'accueil et présentation de l'atelier.

Swad est à l'origine issu de la librairie Dokiel (dkCore).

Pour toute question sur Swad, rejoignez le forum de Dokiel, dédié à la thématique de la documentation logicielle.

1. Envoyez simplement un mail vide à l'adresse suivante : dokiel-subscribe@scenari-platform.org

2. Vous recevrez une réponse automatique. Répondez à ce message pour activer votre inscription.

3. Vous êtes inscrit à la mailing-list de Dokiel ! Vous recevrez dans votre messagerie les messages de la mailing-list ainsi que les messages postés sur le forum de Dokiel.

Pour écrire à la mailing-list il suffit d'envoyer un mail à l'adresse suivante : dokiel@scenari-platform.org.