Digital Tool Documentation /Documenter des outils numériques

(Version française ci-dessous)

This note was created as part of interConnect, a collaborative inquiry into digital transformation. Learn more in the box at the end of the text.

Introduction

Digital tools are integral to the ecosystem of an arts organization. As organizations grow, these tools are often adopted to address new needs and eventually become seamless components of an organization’s collective workflow.

While a reliance on digital tools is universal to all organizations, the collection of tools and how they are used is often in flux and highly individualized to each organization. The choice and general assembly of digital tools is based on the organization’s scale, budget, and unique needs. 

Importance of documentation

Arts workers typically juggle many tasks and responsibilities within their roles. Creating and maintaining documentation is often an undervalued and overlooked practice. From a macro lens, however, documentation is integral to an organization’s adaptability. Documenting the digital systems of an organization is effectively maintaining both a figurative and literal instruction manual for the inner system of cogs and wheels that allows an organization to operate and flourish. 

Outcomes of digital documentation:

• Onboarding & transition: Expediates onboarding of new staff and volunteers
• Collaboration: Facilitates collaboration among staff and volunteers
• Troubleshooting: Aids in troubleshooting technical issues
• Organizational strategy: Provides an opportunity to understand and visualize a full-scale system, rather than an assortment of various digital tools. This vantage point facilitates higher level organizational strategy and strategic planning.

Documentation format

Documentation typically takes the form of written documents. Live documents are advantageous over static ones. They allow for (and encourage) regular updating and maintenance. With the speed at which our digital tools evolve and iterate, this ensures documentation is kept up to date.

Documentation can be especially effective when information is periodically visualized in the form of:

• flow charts and system maps
• videos or screen recordings
• screenshots
• graphs and data visualization

Our example:

From here on, we’ll use a fictional artist-run center organization called The F Stop as an example. For context, The F Stop is a member-based artist run center that offers rental of photography studios and equipment. It has a gallery space where members can apply to show their work in regularly programmed exhibitions. 

How to begin

Beginning a documentation system from scratch can feel daunting, particularly for organizations that have adopted multiple different digital tools. Follow these steps to get started:

List your tasks & activities

What does your organization do? Think about it on a macro and micro scale, including higher-level strategic planning, regular programming or services, day-to-day staff tasks, and everything in between.

Breaking this down into two categories can be helpful:

Internal activities

Any activities or tasks done by staff members that facilitate their workflow. These are often administrative in nature.

Common examples:

• Inter-staff communication (ex. emailing, team messaging, video chat, meeting scheduling, calendars)
• File sharing & storage (ex. cloud storage, backup software, file transfer)
• Project management (ex. project & deadline tracking, task assignment)
• Collaboration (ex. brainstorming (remote & in person), ideas exchange, planning)
• Finances & bookkeeping (ex. budget planning, income/expense tracking, payroll) 
• Document/asset creation (ex. report or document writing & editing, slide deck design)

External activities

Any programming or activities that directly involve or engage individuals or groups outside of your organization.

Common examples:

• Website (ex. website builders, hosting platforms)
• E-commerce (ex. online stores, payment processing)
• Marketing & content creation (ex. mailing list tools, social media, promo material design)
• Member management (ex. member databases, content management systems)
• Billing (ex. invoicing, payment processing)
• Events (ex. scheduling, ticket sales, admission/attendance tracking)

List your digital tools

With a complete picture of the scope of your organization’s internal and external tasks and activities, your next step is to list which tools your organization has adopted to initiate, facilitate or complete them. At this stage, you may begin to realize that there are more digital tools used than you initially may have guessed. This is understandable when we think about how seamlessly these tools become integrated into our workflows. 

Example

The F-Stop (our fictional artist run centre)’s list of tasks & tools:

Internal tools

• Inter-staff communication
• Emailing - Gmail
• Team messaging - Slack
• Video meetings - Zoom
• Calendar & scheduling - Google calendar
• File sharing & storage
• File sharing & storage - Google Drive
• Finances & bookkeeping
• Accounting - Quickbooks
• Member management
• Member database - Airtable

External tools

• Website
• Hosting & building - Webflow
• Digital marketing
• Social media - Instagram
• Member mailing - SendGrid
• Billing
• Invoicing, payment processing - Quickbooks
• Facility & equipment rental
• Scheduling - Brightly
• Billing - Quickbooks

Tool breakdown

Write a breakdown for each of these tools. The level of detail may vary depending on the scope of your documentation, but you ultimately want to document and communicate two things:

1. How the tool is used
2. When the tool is used

Tool breakdowns may take the form of a series of documents, or may be written up into one document with navigable sections. 

Template

Consider using the following template. Keep in mind you may want to add or remove information fields depending on the scope of your documentation. 

Tool Breakdown

Name of Digital Tool

Tool type / short description: a short descriptor of the tool’s primary functionality, one sentence max

Used for: a bullet list of each individual task or activity the tool is used for

Used since: a rough date of when the tool was first adopted by your organization

Login info: Include any usernames and passwords required to access or use the tool

Billing:

• • • Subscription type
    • Cost
    • Subscription renewal date
    • Payment card used (last 4 digits)

Connections:

Explain or illustrate how this tool interacts with other tools or processes. These interactions may be manual or automated. 

For example, your organization may use a social media or marketing platform to advertise and promote events. That marketing may then lead to a second tool that sells tickets and tracks admission. The ticket sales tool may offer the option for customers to sign up for a newsletter, which is created and delivered by an email marketing tool. All together, this makes up a system that is important to document. Flow charts are great ways to do this. This example may be illustrated like so:

Instructions:

Certain tasks may benefit from step-by-step instructions. Using an accounting tool as an example, it might be helpful to include a basic overview of how to create a new invoice, track an expense, etc.

Notes:

Any relevant or pertinent notes or details pertaining to how the tool should be used, for example:

• • • Are there any standard templates that should be used?
    • How many users are able to use the software simultaneously?
    • Is automation software being used to automate a process between this tool and another?
    • Are there any points of friction reported by staff or users?
    • Are only a selection of the tool’s features used? Which ones? Are there any to specifically avoid?

Example

Using The F-Stop, our fictional artist-run centre, as an example, here is an example of a tool breakdown:

Tool Breakdown

Eventbrite

Tool type / short description: event management and ticketing tool

Used for:

• • • ticket sales
    • event admission tracking
    • payment processing

Used since: May 2015

Login info:

username:  info@thefstop.com

password:  onetwothree123

Billing:

• • • Enterprise plan
    • $100 monthly
    • auto-renews monthly on the 25th 
    • Paid with Visa ****3492

Connections:

Instructions:

How to create an event:

1. 1. 1. Go to Events Workspace
      2. Click “Create an Event”
      3. Add all info (dates, venue, description, etc)
      4. Add an image (avoid generic stock photography)
      5. Have another staff member double-check for inaccuracies, spelling errors, etc.
      6. For online events: add Zoom link
      7. Publish event

Notes:

• • • Our Instagram account is officially linked to Eventbrite 
    • Some customers have reported their tickets were never emailed to them. If this occurs, have them check their Spam inbox. If their tickets aren’t there, they likely made a typo when entering their email address.

About this note   

• This note was nurtured by the discussions that took place during interConnect workshops, particularly those of co-learning group 2.2. 
• Note authored by Heather Fulton with revision support from the interConnect team.
• Translation from English to French by Marie-Camille Lalande.

The interConnect initiative was led by the Independent Media Arts Alliance (IMAA). The views expressed in this note are those of the author(s) and not official IMAA recommendations.

//////////////////////////////////////////////////

(Version française)

Cette note a été créée pendant interConnect, une enquête collaborative sur la transformation numérique. Apprenez-en davantage dans l’encadré à la fin du texte.

Introduction

Les outils numériques font partie intégrante de l’écosystème d’un organisme artistique. Ces outils sont souvent adoptés à mesure que les organismes se développent afin de répondre à de nouveaux besoins, et finissent par s’intégrer totalement au flux de travail collectif.

Si tous les organismes ont recours à des outils numériques, l’ensemble d’outils et la manière dont ils sont utilisés sont souvent en évolution et personnalisés selon les organismes. Le choix et la configuration générale des outils numériques sont basés sur l’échelle, le budget et les besoins uniques de l’organisme.

Importance de la documentation

Les personnels d’organismes artistiques jonglent généralement avec plusieurs tâches et responsabilités dans le cadre de leurs fonctions. La création et la mise à jour de documentation sont souvent une pratique sous-estimée et négligée. Pourtant, d’un point de vue macro, la documentation fait partie intégrante de la capacité d’adaptation d’un organisme. Documenter les systèmes numériques d’un organisme, c’est essentiellement tenir à jour un manuel d’instruction, au sens figuré comme au sens propre, des rouages qui permettent à un organisme de fonctionner et de s’épanouir. 

Résultats de la documentation numérique :

• Intégration et transition : Accélère l’intégration des nouveaux·elles membres du personnel et bénévoles.
• Collaboration : Facilite la collaboration entre le personnel et les bénévoles
• Dépannage : Aide à la résolution des problèmes techniques
• Stratégie organisationnelle : Permet de comprendre et de visualiser un système à grande échelle, plutôt qu’un assortiment de divers outils numériques. Ce point de vue facilite l’élaboration d’une stratégie organisationnelle et d’une planification stratégique de haut niveau.

Le format de la documentation

La documentation prend généralement la forme de documents écrits. Les documents évolutifs (lien en anglais uniquement) sont plus avantageux que les documents statiques. Ils permettent (et encouragent) la mise à jour et l’entretien réguliers. Compte tenu de la vitesse à laquelle nos outils numériques évoluent et se renouvellent, cela permet aussi de garantir que la documentation reste à jour.

La documentation peut être particulièrement efficace lorsque les informations sont représentées sous les formes suivantes :

• organigrammes et de cartes du système
• vidéos ou enregistrements d’écran
• captures d’écran
• graphiques et visualisation de données

Notre exemple :

À partir de maintenant, nous utiliserons comme exemple un centre d’artistes autogéré fictif appelé La focale. Pour situer le contexte, La focale est un centre d’artistes géré par ses membres, qui propose la location de studios et d’équipements photographiques. Il dispose d’une galerie où les membres peuvent demander à exposer leurs œuvres dans le cadre d’expositions programmées régulièrement.

Comment commencer

La mise en place de toutes pièces d’un système de documentation peut sembler écrasante, en particulier pour les organismes qui ont adopté de nombreux outils numériques différents. Suivez les étapes suivantes pour commencer :

Faites la liste de vos tâches et activités

Que fait votre organisme ? Pensez à l’échelle macro et micro, y compris la planification stratégique de haut niveau, la programmation ou les services courants en passant par les tâches quotidiennes du personnel, et tout le reste.

Il peut être utile de diviser cette liste en deux catégories :

Activités internes

Toutes les activités ou tâches effectuées par les membres du personnel qui facilitent leur travail. Elles sont souvent de nature administrative.

Exemples courants :

• Communication entre les membres du personnel (par exemple, courriel, messagerie d’équipe, chat vidéo, planification de réunions, calendriers).
• Partage et stockage de fichiers (ex. : stockage infonuagique, logiciel de sauvegarde, transfert de fichiers)
• Gestion de projet (ex. : suivi des projets et des délais, attribution de tâches)
• Collaboration (ex. : remue-méninges [à distance et en personne], échange d’idées, planification)
• Finances et comptabilité (ex. : planification budgétaire, suivi des revenus et des dépenses, paie) 
• Création de documents (ex. : rédaction et édition de rapports ou de documents, conception de diapositives)

Activités externes

Toute programmation ou activité qui implique ou fait directement participer des individus ou des groupes en dehors de votre organisme.

Exemples courants :

• Site web (ex. : création de sites web, plateformes d’hébergement)
• Commerce électronique (ex. : boutiques en ligne, traitement des paiements)
• Marketing et création de contenu (ex. : outils de listes de diffusion, médias sociaux, conception de matériel promotionnel)
• Gestion des membres (ex. : bases de données de membres, systèmes de gestion de contenu)
• Facturation (ex. : facturation, traitement des paiements)
• Événements (ex. : programmation, vente de billets, suivi des entrées et de la fréquentation)

Faites la liste de vos outils numériques

Après avoir brossé un tableau complet de l’étendue des tâches et activités internes et externes de votre organisme, l’étape suivante consiste à dresser la liste des outils adoptés pour commencer, mettre en œuvre ou mener à bien ces tâches et activités. À ce stade, vous commencerez peut-être à vous rendre compte que vous utilisez plus d’outils numériques que vous ne l’aviez imaginé au départ. C’est normal, si l’on pense à la fluidité avec laquelle ces outils s’intègrent dans nos flux de travail. 

Exemple

La liste des tâches et des outils de La focale (notre centre d’artistes fictif) :

Outils internes

• Communication entre membres du personnel
• Courriel — Gmail
• Messagerie d’équipe — Slack
• Réunions vidéo — Zoom (en anglais)
• Calendrier et planification — Google Agenda
• Partage et stockage de fichiers
• Partage et stockage de fichiers — Google Drive
• Finances et comptabilité
• Comptabilité — Quickbooks
• Gestion des membres
• Base de données de membres — Airtable

Outils externes

• Site web
• Hébergement et construction — Webflow
• Marketing numérique
• Médias sociaux — Instagram
• Publipostage aux membres — SendGrid (en anglais seulement)
• Facturation
• Facturation, traitement des paiements — Quickbooks
• Location de locaux et d’équipements
• Planification — Brightly (en anglais seulement)
• Facturation — Quickbooks

Analyse des outils

Rédigez une analyse pour chacun de ces outils. La quantité de détail peut varier en fonction de l’étendue de votre documentation, mais tentez de documenter et communiquer deux choses :

1. Comment l’outil est utilisé
2. Quand l’outil est utilisé

Les descriptions d’outils peuvent être présentées sous forme de série de documents ou en tant que document unique comportant des sections navigables. 

Modèle

Voici un modèle que vous pouvez utiliser. N’oubliez pas : vous pouvez ajouter ou supprimer des champs d’information en fonction de l’étendue de votre documentation. 

Analyse des outils

Nom de l’outil numérique

Type ou brève description de l’outil : brève description de la fonctionnalité principale de l’outil ; une phrase maximum.

Sert à : une liste à puces de chaque tâche ou activité pour laquelle l’outil est utilisé.

Utilisé depuis : date approximative à laquelle l’outil a été adopté pour la première fois par votre organisme.

Info de connexion : Indiquez les identifiants et les mots de passe nécessaires pour accéder à l’outil ou l’utiliser.

Facturation :

• • • Type d’abonnement
    • Coût
    • Date de renouvellement de l’abonnement
    • Carte de paiement utilisée (4 derniers chiffres)

Connexions :

Expliquez ou illustrez comment cet outil interagit avec d’autres outils ou processus. Ces interactions peuvent être manuelles ou automatisées. 

Par exemple, votre organisme utilise un média social ou une plateforme de marketing pour annoncer et promouvoir des événements. Cette promotion peut ensuite conduire à un second outil qui vend des billets et traite les entrées. L’outil de vente de billets offre à la clientèle la possibilité de s’inscrire au bulletin, qui est créé et diffusé par un outil de marketing par courriel. L’ensemble constitue un système qu’il est important de documenter. Les organigrammes sont un excellent moyen d’y parvenir. Cet exemple peut être illustré comme suit :

Instructions :

Certaines tâches peuvent demander des instructions étape par étape. En prenant l’exemple d’un outil de comptabilité, il peut être utile d’inclure un aperçu de base de la façon de créer une nouvelle facture, de suivre une dépense, etc.

Notes :

Toute note ou tout détail pertinent concernant l’utilisation de l’outil, par exemple :

• • • Existe-t-il des modèles de base à utiliser ?
    • Combien de personnes peuvent utiliser le logiciel en même temps ?
    • Un logiciel d’automatisation est-il utilisé pour automatiser un processus entre cet outil et un autre ?
    • Y a-t-il des points de friction signalés par le personnel ou les utilisateur·trice·s ?
    • Est-ce qu’une seule partie des fonctionnalités de l’outil est utilisée ? Lesquelles ? Y en a-t-il en particulier qui doivent être évitées ?

Exemple

Si l’on prend l’exemple de La focale, notre centre d’artistes fictif, voici un exemple d’analyse d’un outil :

Analyse de l’outil

Eventbrite

Type ou brève description de l’outil : outil de billetterie et de gestion d’événements 

Sert à :

• • • vente de billets
    • suivi des entrées aux événements
    • traitement des paiements

Utilisé depuis : mai 2015

Info de connexion :

identifiant : info@lafocale.com

mot de passe : undeuxtrois 123

Facturation :

• • • plan “Professional”
    • 100 $ par mois
    • renouvellement automatique chaque 25 du mois 
    • payé avec la carte Visa **** 3492

Connexions :

Instructions :

Comment créer un événement :

1. 1. 1. Accéder à l’espace de travail des événements.
      2. Cliquez sur « Créer un événement ».
      3. Ajoutez toutes les informations (dates, lieu, description, etc.)
      4. Ajoutez une image (évitez les photographies génériques).
      5. Demandez à quelqu’un d’autre de vérifier s’il y a des inexactitudes, des fautes d’orthographe, etc.
      6. Pour les événements en ligne : ajouter un lien Zoom.
      7. Publier l’événement.

Notes :

• • • Notre compte Instagram est officiellement lié à Eventbrite. 
    • Des client·e·s ont signalé que leurs billets ne leur avaient jamais été envoyés par courriel. Si c’est le cas, demandez-leur de vérifier leur boîte de pourriels (spam). Si les billets ne s’y trouvent pas, demandez-leur de vérifier si une faute de frappe a été faite en tapant leur adresse courriel.

À propos de cette note

• Cette note a été inspirée par les discussions qui ont eu lieu au cours des ateliers d’interConnect, particulièrement du groupe d’apprentissage collaboratif 2.2.
• Note écrite par Heather Fulton et révisée par l’équipe d’interConnect.
• Traduction de l’anglais vers le français par Marie-Camille Lalande.

L'initiative interConnect a été menée par l'Alliance des arts médiatiques indépendants (AAMI). Les opinions exprimées dans cette note sont celles des auteur·trice·s et ne constituent pas des recommandations officielles de l'AAMI.