Presentations

Requirements and Relevance of International Standards for Software Documentation
Michael Fritz, (CEO) tekom / tekom Europe / tcworld GmbH
IEC 82079-1:2012 is the most important standard for technical documentation. As a so-called “horizontal standard”, IEC 82079-1 “provides general principles and detailed requirements for the design and formulation of all types of instructions for use that will be necessary or helpful for users of products of all kinds.” This includes pure software products and their documentation as well as physical products with embedded software.
In this presentation you will learn why and how IEC 82079-1 is applicable for software documentation. You will also get an overview of the most important ISO standards on software documentation (e.g. the ISO IEC 2651x series) and their interplay with IEC 82079-1.
From Unstructured Documentation to Structured Topics
Kai Weber, SimCorp GmbH
You're sold on the benefits of structured content, but don't know how to begin? This session shows you how to implement topic-based authoring by converting existing unstructured documentation into structured topics.
The underlying process works for online help, user manuals, but also other content, including videos, wiki articles, training materials, etc., as long as you know which deliverables you need to create.
You start with a content model that identifies purposes and use cases of your documentation and defines topic types for these purposes.
Then there are several stages to the conversion process of your content. First, you identify topic type or types per content section, for example, concept, task, reference, or use case. Content which mixes topic types can be sorted out with a little care.
Second, re-chunk your sections to turn them into stand-alone topics. You can delete redundant or obsolete information which does not belong into a topic. Or you can spin it off into a topic of its own or integrate it with another, more suitable topic. Special strategies help you to deal with topics that are too complex.
Third, re-sequence your topics, so they flow nicely when users read not just one or two of them, but need to follow a complete process. If the topic sequence doesn’t flow nicely, you may need to add some auxiliary topics which orient readers and ensure a good flow.
Fourth, rewrite headings to guide readers to give users enough orientation when they read just one or two topics. Rephrase them so users can quickly dip in and out of your documentation.
Last, add links between related topics to ensure that the structured topics work in various use cases, even if users refer only to few topics.
This presentation emphasizes practical tasks; you will learn:
  • How and why to create a structured content model
  • How to identify topic types in existing content
  • How to re-chunk content into true topics
  • How to sequence your topics
  • How and why to write good headings for your topics
  • How to link related topics
Using DITA to Enable Multi-Language, Multi-Channel Publishing
Laura Katajisto, Microsoft

Do you need to produce content into many channels in many languages? If yes, read on. Do you want to use standards and structured content to avoid tool lock-in and to guarantee the uniform quality of that content? Keep reading. Are you also looking for case studies? Then this is the right presentation for you.

This presentation describes how we use DITA to create support content for phones and phone accessories, localise it into 50+ languages, and publish it into print guides, web guides, and in-device guides. First, you’ll hear why and how we switched to DITA. Second, you’ll learn what are keyrefs, conrefs, and conkeyrefs and how we use them, get a summary and samples of conref push and pull, see examples on how to utilise subject schemes to control metadata, and hear how conditions help to produce one single source with all required regional and legal variation in it. Finally, you’ll find out how all this combines together into a deliverable, and how those deliverables are distributed to dozens of product variants and websites. The speed and efficiency of our content production and publishing would not be possible without a content management system or DITA, and to end the presentation, we’ll discuss a few numbers that proved this to our managers. Let’s see how revealing those numbers can be! 

L’automatisation de la mise en page et la flexibilité ne sont pas en contradiction!
Sebastian Göttel, SCHEMA Group

Le coût élevé pour la publication de documentation imprimée dans un marché mondialisé est en partie dû à la traduction, mais aussi aux coûts d'adaptation de mise en page pour chaque traduction. La finalisation manuelle dans la langue source est souvent répétée dans chaque langue cible. En règle générale, le coût de mise en page dévore près de 50% des coûts totaux de la traduction dans la documentation technique.

Il n'est pas surprenant que le plus grand avantage de DITA et XML réside dans l'automatisation de la mise en page et non dans la réutilisation ou dans d'autres fonctions. Malheureusement, l'un des principaux défis du déploiement de DITA et XML réside dans l'automatisation de la mise en page.

La plupart des environnements de documentation XML doivent produire une documentation imprimée. Pour cela, la norme XML propose XSL-FO comme un mécanisme puissant pour transformer le contenu de format neutre d’XML en documents PDF d'aspect professionnel. La mise en place d'une chaîne de transformation XML / XSL-FO / PDF est une tâche fastidieuse effectuée par des personnes aux compétences techniques élevées, des développeurs en général.

Si une ou deux maquettes sont utilisées, c'est juste un obstacle supplémentaire au déploiement de la documentation XML. Mais que faire s’il y a des dizaines, voire des centaines de maquettes différentes? Finalement, l'automatisation de la mise en page devient si chère qu'elle n’est possible que pour les très grands projets. Fournir des environnements XML dans des domaines avec de telles exigences de mise en page est alors pratiquement impossible.

Que faire si la maquette exigée ne peut être automatisée entièrement?
L'utilisation de formats ouverts et modifiables au lieu de PDF peut poser d'autres problèmes en ce qui concerne la performance, la sécurité et le temps dépensé en manipulant la mise en page. Une fois le contenu modifié, les documents doivent être régénérés. Ensuite, ce réglage fin manuel doit être répété. Et ça de nouveau à chaque fois. Cela peut être un inconvénient grave pour la transition vers un système de gestion de contenu XML.

Dans sa présentation, Sebastian Göttel explique une approche alternative pour relever le défi en permettant d'automatiser la mise en page sans programmation et la réutilisation de réglage fin. L’automatisation de la mise en page et la flexibilité ne sont pas nécessairement en contradiction!

Les communautés intégrées des "Enjeuteurs": votre meilleur capital
Ray Gallon, Culturecom

Une fois dans les mains de vos clients, votre produit est le principal canal de communication entre vos clients et votre société. Il est trop commun, hélas, d’oublier cette fonction communicative de l'interface. Souvent le design ergonomique ou l'assistance à l'utilisateur (UA) que nous avons imaginé tellement lucide et intuitif, arrive simplement à  confondre ceux qui doivent réellement travailler avec nos produits.
Une meilleure expérience client est pourtant possible, offrant en même temps plus de satisfaction de la clientèle et la réduction des appels au service d’assistance. Nous devons rencontrer nos clients à travers les réseaux sociaux, et les utiliser pour développer des communautés intégrées des "enjeuteurs" (stakeholders - parties prenantes).
Nous sommes tous responsables, collectivement et personnellement, de l'expérience de la clientèle de bout en bout. De plus ces communautés intégrées, qui sont beaucoup plus qu'un groupe d'utilisateurs, nous aident à faire, ou à refaire, la conception de nos produits ainsi que son contenu informationnel. L'engagement et l'adhésion du client sont ensuite renforcés, ce qui contribue fortement au développement de la fidélité des clients. Et cette fidélité est votre acquis le plus important.
Dans cette présentation, vous allez apprendre:

  • Comment l'UA et d'autres informations techniques se situent dans une stratégie générale de contenu.

  • Quelles sont les caractéristiques d'un utilisateur expert, et pourquoi vous devez vous occuper de leur développement.

  • Comment vous pouvez employer les utilisateurs experts dans une communauté intégrée d'enjeuteurs pour améliorer vos produits et sécuriser la fidélité de vos clients.

Stimuler la recherche en communication technique à l'Université Paris Diderot: Méthodologie et outils conceptuels pour favoriser l'Innovation par la collaboration
Virginie Ahrens (Past) - Patricia Minacori (Maître de conférences)
Dans cette présentation, nous avons pris le pari d'expliquer comment les étudiants du Master 2 de Paris Diderot sont accompagnés dans leurs projets de recherche en communication technique. Nous pensons en effet que les étudiants doivent s'impliquer dans une démarche de recherche sur un sujet en phase avec leur pratique de la communication technique en alternance: c'est pour eux la meilleure façon d'acquérir de nouvelles compétences professionnelles et de contribuer ainsi à développer une démarche de recherche dans leur entreprise d'accueil.
Voici les différents thèmes abordés dans cette présentation
  • La recherche est un enseignement clé pour les étudiants en communication technique. A ce titre elle mobilise plusieurs compétences: quelles sont-elles? Quel est l'impact de la recherche sur la manière dont les étudiants conçoivent et mènent leurs projets de communication technique en entreprise?
  • En quoi la démarche de recherche est-elle une source de créativité et quels sont les avantages de cette démarche pour les entreprises partenaires?
  • Comment promouvoir l'innovation en communication technique en s'associant aux modules de projets de recherche de l'Université Paris Diderot?

Dans une première partie, nous allons décrire les caractéristiques principales du programme de Master 2 de communication technique à Paris Diderot et les grands principes de l'alternance. Nous allons dégager les raisons pour lesquelles la recherche à Paris Diderot est la clé de voute de cette formation, ainsi qu'une dimension incontournable du métier de communicateur technique.
Nous parlerons en particulier de la valeur ajoutée de cette approche pour les communicateurs techniques et nous illustrerons, à travers des exemples concrets, comment la démarche exploratoire mise en oeuvre dans les projets de recherche amène naturellement les communicateurs techniques à questionner l'existant et à proposer des évolutions de leurs pratiques et de leur environnement de travail. Et ce faisant, à diffuser l'innovation au coeur des entreprises.

La deuxième partie expose les critères et les attentes de ces projets de recherche. Nous détaillerons la méthodologie et les outils conceptuels développés pour formaliser une démarche exploratoire construite autour d'un environnement collaboratif qui favorise le partage de connaissances et l'innovation.

Tout au long de l'exposé nous illustrerons les défis auxquels les étudiants doivent faire face et nous donnerons des exemples concrets de mise en oeuvre des outils utilisés.

En conclusion, nous présenterons les grandes tendances de la recherche en communication technique en 2014, issues des projets de recherche menés cette année et nous proposerons des ressources pour que les entreprises intéressées puissent, à leur tour, bénéficier de cette démarche.

Our Sponsor for all cities

Our Sponsors

Supported by