Driving DITA off the Map

•

0 likes•549 views

Publications in DITA are handled via dita maps. Even with conditions and DITAVAL options, these are inherently static and bound to an old book type paradigm. In this presentation I am trying to outline a new paradigm, where the disclosure of information is made truly dynamic. Doing away with maps or at least with one single top-level map that defines all content. Having a dynamic information disclosure layer in place may prepare our technical content for the fast-moving world of today (which will move even faster tomorrow).

Driving DITA off the Map
Jang F.M. Graat

Who’s talking ?
• Jang F.M. Graat
• Amsterdam
• Part-time tech comms
specialist (25+ years)
• Full-time philosopher
• Box ? What box ?
• Addicted to challenge

Driving DITA off the Map
Toward (Much) More Intelligent
Information Disclosure

What is installed ?
A B C D E F G H
GUI a X X X X
GUI b X X X
GUI c X X
library 1 X X X
library 2 X X X X X X
library 3 X X X X
.NET X X X X
SQL X X X
PHP X X X X

Intelligent disclosure
information elements (multiple versions)
maps, indexes, cross-refs, search results
product a product b product c

c X
X
X
Dynamic toc, index, etc.
information elements (multiple versions)
a b

Dynamic topic linking
information elements (multiple versions)
a b c

The main focus of my talk is how DITA works well in an Agile environment for technical publication to produce simple, crisp, and lean user documentation per sprint. Just as programmers employ Agile techniques to improve their deliverables, task-oriented documentation using DITA helps technical writers in creating user deliverables that allows for continuous feedback and improve the documentation’s velocity and adaptability to change, even extreme changes.

Short Descriptions Shouldn't Be a Tall Order: Writing Effective Short Descrip...

IXIASOFT

Beyond the Book and the Class: Using DITA for Training & Support

Lasselle-Ramsay

The DITA Learning and Training Specialization

IXIASOFT

Brain Anatomy

Lasitha vipin

English Parts Of Speech

guesta684c8b

Using APEX for Mobile Web Applications has always lead to a limited user experience, compared to native mobile applications. The use of jQuery Mobile was a valid approach to overcome this, but had it’s difficulties and booby-traps for the developers. Recent enhancements to Universal Theme in APEX version 18 improved the UX. Combine this with the latest PWA features to provide a better user experience, mobile versions of APEX web applications are becoming much more user friendly and native-like. I will explain the mobile functionality of APEX and Universal Theme, like mobile specific components and templates, touch gestures based dynamic actions, and show a real life public facing (mobile) web application. Beyond standard APEX functionality, I will show how to improve the mobile user experience with transition effects and PWA features like off-line handling, shortcut icons and notifications. Keep’s you moving …

Accessible Next Level Visualizations

Ted Gies

From Science to Data: Following a principled path to Data Science

Institute of Contemporary Sciences

An introductory but highly practical talk on starting a Data Science career and life. It touches upon all the main aspects of the path towards becoming a Data scientist, also seen through a personal development perspective. Moreover, we talk about the role that a data scientist ultimately fulfills - as an individual or as a team - in the technology innovation life cycle and the product life-cycle.

Hexagonify the World: The Theory and Applications of Uber H3

Safe Software

Imagine having more spatial data than you know what to do with, and yet it holds the key to improving your customer’s experience and your company’s bottom line. That’s the situation that Uber found themselves in, so they created a Hexagonal Hierarchical Spatial Indexing library (called H3) that indexes the world in 16 different levels of resolution as the foundation for solving their challenge. Fortunately for all of us, Uber open sourced H3 and the upcoming FME 2021.0 release will provide no-code, format agnostic access to its functionality. Join us to learn theory behind H3 directly from Unfolded’s Isaac Brodsky, one of the creators of H3, and see firsthand how you might apply the upcoming FME H3 transformer to solve a variety of real-world, big-data spatial problems.

Tech Talk overview of xgboost and review of paper

Tushar Tank

2014 01-ticosa

Pharo

Platform for Big Data Analytics and Visual Analytics: CSIRO use cases. Februa...

Tomasz Bednarz

Exploration and 3D GIS Software - MapInfo Professional Discover3D 2015

Prakher Hajela Saxena

3D Volumetric Data Generation with Generative Adversarial Networks

Preferred Networks

VMworld Europe 2014: From the Fire Hose Series - 3D Graphics for Virtual Desk...

VMworld

Software & programming languages for undergraduate students (Ag. Engg)

Moudud Hasan

Hoe een efficiënte Machine of Deep Learning backend ontwikkelen?

Agentschap Innoveren & Ondernemen

Qrious about Insights -- Big Data in the Real World

Guy K. Kloss

XSLT for Authors

Jang F.M. Graat

Faster than Agile - Proposal for Lavacon 2015

Jang F.M. Graat

Similar to Driving DITA off the Map

Miguel Vargas.CVJose Miguel Vargas Felix

Data science tools - A.Marchev and K.Haralampiev

Data Science Society

Session 04 communicating results

bodaceacat

Session 04 communicating results

Sara-Jayne Terp

Paris ML meetup

Yves Raimond

Parismlmeetupfinalslides 151209190037-lva1-app6892

mercedes calderon

Digital fabrication for k 12 education

Patrick Woessner

Keep me moving goin mobile

Christian Rokitta

Accessible Next Level Visualizations

Ted Gies

From Science to Data: Following a principled path to Data Science

Institute of Contemporary Sciences

Hexagonify the World: The Theory and Applications of Uber H3

Safe Software

Tech Talk overview of xgboost and review of paper

Tushar Tank

2014 01-ticosa

Pharo

Platform for Big Data Analytics and Visual Analytics: CSIRO use cases. Februa...

Tomasz Bednarz

Exploration and 3D GIS Software - MapInfo Professional Discover3D 2015

Prakher Hajela Saxena

3D Volumetric Data Generation with Generative Adversarial Networks

Preferred Networks

VMworld Europe 2014: From the Fire Hose Series - 3D Graphics for Virtual Desk...

VMworld

Software & programming languages for undergraduate students (Ag. Engg)

Moudud Hasan

Hoe een efficiënte Machine of Deep Learning backend ontwikkelen?

Agentschap Innoveren & Ondernemen

Qrious about Insights -- Big Data in the Real World

Guy K. Kloss

Similar to Driving DITA off the Map (20)

Miguel Vargas.CV

Data science tools - A.Marchev and K.Haralampiev

Session 04 communicating results

Paris ML meetup

Parismlmeetupfinalslides 151209190037-lva1-app6892

Digital fabrication for k 12 education

Keep me moving goin mobile

Accessible Next Level Visualizations

From Science to Data: Following a principled path to Data Science

Hexagonify the World: The Theory and Applications of Uber H3

Tech Talk overview of xgboost and review of paper

2014 01-ticosa

Platform for Big Data Analytics and Visual Analytics: CSIRO use cases. Februa...

Exploration and 3D GIS Software - MapInfo Professional Discover3D 2015

3D Volumetric Data Generation with Generative Adversarial Networks

VMworld Europe 2014: From the Fire Hose Series - 3D Graphics for Virtual Desk...

Software & programming languages for undergraduate students (Ag. Engg)

Hoe een efficiënte Machine of Deep Learning backend ontwikkelen?

Qrious about Insights -- Big Data in the Real World

More from Jang F.M. Graat

XSLT for Authors

Jang F.M. Graat

Faster than Agile - Proposal for Lavacon 2015

Jang F.M. Graat

Out of-control

Jang F.M. Graat

Flowcharting DITA

Jang F.M. Graat

This short presentation shows how a homegrown flowchart editor, running in a web browser, can be used to design DITA tasks. Instead of painstakingly editing the steps and choice tables, linking them by cross-references, just draw a flowchart and connect its building blocks. Let the software transform your design into a valid and correct DITA task. Of course, you can also skip the DITA and go for interactive HTML5 plus JavaScript.

From user assistance to user guidance: Information apps

Jang F.M. Graat

Minimalism in technical documentation ultimately leads to using interactive procedures. The advantages of moving control from the user's head to a connected device are countless. But there has to be an easier way of building these so-called information apps (or procedure apps). This presentation shows how the implicit flowchart the designers have in their minds when writing a procedure can be made explicit in a graphical interface, which produces the HTML5 code. Easy design, easy error correction, no more reasons to not use procedures instead of relying on service manuals, training service staff, and the absence of stress on the work floor, where safety-critical procedures are required.

Minimalism to the MAX

Jang F.M. Graat

Dynamic links using (meta)data

Jang F.M. Graat

Creating links in technical content greatly supports the user experience, but as technical content evolves, such links are getting harder to handle. Creating static links that are resolved while building the output will not work out in the end, as content creation is moving into the agile world. This is where a new paradigm is required, which enables authors to create semantically defined links, which will be resolved by querying the database of available topics, during runtime. This revolutionises the way we think about cross-references and hyperlinks.

Maximising the effect of progressive disclosure

Jang F.M. Graat

Minimalism in technical documentation states that we should only deliver info that the user needs. But how can we know what each individual user already knows (and does not need)? The answer is: we cannot. And this is why we should use progressive disclosure techniques to optimize the help we offer to our customers, so that each individual customer can decide for himself whether more info is needed or not, and on which aspects more info is needed. There is one important catch: Implementing progressive disclosure can be a lot of work and be too costly to do. The solution to this budgetary problem is to use a well-defined structure in your content (preferably DITA) and an XSLT that automatically adds the required hooks and handles (triggers and targets) to make progressive disclosure work.

Progressive Disclosure - Putting the User in Control

Jang F.M. Graat

XPath-based transformations in structured FrameMaker

Jang F.M. Graat

XSLT allows you to transform the structure of XML files into anything you need. As structured FrameMaker is not exactly XML but follows the same structured design, the capabilities of XSLT within the FrameMaker environment can be very useful. The FrameSLT plug-in produced by West Street Consulting offers this functionality at a very low price. This presentation gives an introduction to what the tool can do, and what it means to do transformations of structure in technical documents.

Rethinking Version Control for Agile Content

Jang F.M. Graat

Advanced techniques for conversion to structured FrameMaker

Jang F.M. Graat

Having well-formatted content available in FrameMaker enables you to automatically convert that content to structured FrameMaker (and then possibly moving it into XML). Automating the entire process is possible using a combination of preprocessing (with FrameMaker's built-in ExtendScript), smart conversion tables and post-processing (using FrameSLT, a low-cost plug-in for FrameMaker and some more ExtendScript). This tutorial outlines some of the tricks and tips that will get you started.

Create your own $35 CMS in Structured FrameMaker

Jang F.M. Graat

Content Management Systems for technical documentation can be expensive and do not provide a magical solution to all your reuse problems. Often, going through the excercise of building your own custom CMS helps you define your set of requirements, so you will be much better prepared to purchase the exact right CMS for you a couple of years down the road. Building your own CMS based on structured FrameMaker is not a very difficult task and teaches you a lot about all the possible issues when starting with modular documentation and reuse.

Dita Spezialisierung - Wie machen Sie es, und warum Sie es machen sollen.

Jang F.M. Graat

Nur der Nutzer weiss, was der Nutzer noch nicht weiss - Progressive Disclosure

Jang F.M. Graat

Diese Präsentation zeigt, wie Minimalismus in technische Dokumentation letztendlich zu eine Technik führt, die sich auf English "Progressive Disclosure" nennt und am Besten als "fortschreitende Offenlegung" übersetzt werden kann. Warum Progressive Disclosure wichtig ist und wie es handmässig oder auch automatisiert gemacht wird (falls die Inhalte in einer vernünftig strukturierten Form vorliegen).

Changing the engine without stopping the rickshaw

Jang F.M. Graat

This presentation is a reworked version of a joint presentation with a customer at TCWorld in Germany 2012. It shows how the transition from unstructured documentation to the modern world of structured, XML-based and topic-oriented authoring can be made smooth, without interfering with the publication chain. This presentation describes a project that was done using FrameMaker 10 with its built-in ExtendScript toolkit. It shows how being able to mix unstructured and structured content, including a DITA-type conref mechanism, can be used to keep the system running while the materials are converted and pushed into a repository for reuse one by one. This flattens the legacy documentation hurdle that may keep companies from moving to modern authoring practices.

How I killed the webmaster - and got away with it

Jang F.M. Graat

How to become a trainer - and make lots of $$$

Jang F.M. Graat

Getting your hands dirty - How tech authors may be able to survive in the mac...

Jang F.M. Graat

CADD: What can DITA learn from CAD?

Jang F.M. Graat

In this presentation at DITA Europe 2012, I try to outline a new paradigm for thinking about change impact in heavy reuse environments. I take my inspiration from the world of CAD engineering, which has been working with large numbers of reuse items and heavy interdependencies between those items for decades. Possbily, documentation designers need to start learning something from CAD engineering best practices.

More from Jang F.M. Graat (20)

XSLT for Authors

Faster than Agile - Proposal for Lavacon 2015

Out of-control

Flowcharting DITA

From user assistance to user guidance: Information apps

Minimalism to the MAX

Dynamic links using (meta)data

Maximising the effect of progressive disclosure

Progressive Disclosure - Putting the User in Control

XPath-based transformations in structured FrameMaker

Rethinking Version Control for Agile Content

Advanced techniques for conversion to structured FrameMaker

Create your own $35 CMS in Structured FrameMaker

Dita Spezialisierung - Wie machen Sie es, und warum Sie es machen sollen.

Nur der Nutzer weiss, was der Nutzer noch nicht weiss - Progressive Disclosure

Changing the engine without stopping the rickshaw

How I killed the webmaster - and got away with it

How to become a trainer - and make lots of $$$

Getting your hands dirty - How tech authors may be able to survive in the mac...

CADD: What can DITA learn from CAD?

Recently uploaded

To Graph or Not to Graph Knowledge Graph Architectures and LLMs

Paul Groth

Epistemic Interaction - tuning interfaces to provide information for AI support

Alan Dix

Paper presented at SYNERGY workshop at AVI 2024, Genoa, Italy. 3rd June 2024 https://alandix.com/academic/papers/synergy2024-epistemic/ As machine learning integrates deeper into human-computer interactions, the concept of epistemic interaction emerges, aiming to refine these interactions to enhance system adaptability. This approach encourages minor, intentional adjustments in user behaviour to enrich the data available for system learning. This paper introduces epistemic interaction within the context of human-system communication, illustrating how deliberate interaction design can improve system understanding and adaptation. Through concrete examples, we demonstrate the potential of epistemic interaction to significantly advance human-computer interaction by leveraging intuitive human communication strategies to inform system design and functionality, offering a novel pathway for enriching user-system engagements.

Elevating Tactical DDD Patterns Through Object Calisthenics

Dorra BARTAGUIZ

After immersing yourself in the blue book and its red counterpart, attending DDD-focused conferences, and applying tactical patterns, you're left with a crucial question: How do I ensure my design is effective? Tactical patterns within Domain-Driven Design (DDD) serve as guiding principles for creating clear and manageable domain models. However, achieving success with these patterns requires additional guidance. Interestingly, we've observed that a set of constraints initially designed for training purposes remarkably aligns with effective pattern implementation, offering a more ‘mechanical’ approach. Let's explore together how Object Calisthenics can elevate the design of your tactical DDD patterns, offering concrete help for those venturing into DDD for the first time!

When stars align: studies in data quality, knowledge graphs, and machine lear...

Elena Simperl

PCI PIN Basics Webinar from the Controlcase Team

ControlCase

Software Delivery At the Speed of AI: Inflectra Invests In AI-Powered Quality

Inflectra

In this insightful webinar, Inflectra explores how artificial intelligence (AI) is transforming software development and testing. Discover how AI-powered tools are revolutionizing every stage of the software development lifecycle (SDLC), from design and prototyping to testing, deployment, and monitoring. Learn about: • The Future of Testing: How AI is shifting testing towards verification, analysis, and higher-level skills, while reducing repetitive tasks. • Test Automation: How AI-powered test case generation, optimization, and self-healing tests are making testing more efficient and effective. • Visual Testing: Explore the emerging capabilities of AI in visual testing and how it's set to revolutionize UI verification. • Inflectra's AI Solutions: See demonstrations of Inflectra's cutting-edge AI tools like the ChatGPT plugin and Azure Open AI platform, designed to streamline your testing process. Whether you're a developer, tester, or QA professional, this webinar will give you valuable insights into how AI is shaping the future of software delivery.

Assuring Contact Center Experiences for Your Customers With ThousandEyes

ThousandEyes

Key Trends Shaping the Future of Infrastructure.pdf

Cheryl Hung

From Daily Decisions to Bottom Line: Connecting Product Work to Revenue by VP...

Product School

UiPath Test Automation using UiPath Test Suite series, part 3

DianaGray10

Monitoring Java Application Security with JDK Tools and JFR Events

Ana-Maria Mihalceanu

Kubernetes & AI - Beauty and the Beast !?! @KCD Istanbul 2024

Tobias Schneck

As AI technology is pushing into IT I was wondering myself, as an “infrastructure container kubernetes guy”, how get this fancy AI technology get managed from an infrastructure operational view? Is it possible to apply our lovely cloud native principals as well? What benefit’s both technologies could bring to each other? Let me take this questions and provide you a short journey through existing deployment models and use cases for AI software. On practical examples, we discuss what cloud/on-premise strategy we may need for applying it to our own infrastructure to get it to work from an enterprise perspective. I want to give an overview about infrastructure requirements and technologies, what could be beneficial or limiting your AI use cases in an enterprise environment. An interactive Demo will give you some insides, what approaches I got already working for real.

Designing Great Products: The Power of Design and Leadership by Chief Designe...

Product School

GraphRAG is All You need? LLM & Knowledge Graph

Guy Korland

Guy Korland, CEO and Co-founder of FalkorDB, will review two articles on the integration of language models with knowledge graphs. 1. Unifying Large Language Models and Knowledge Graphs: A Roadmap. https://arxiv.org/abs/2306.08302 2. Microsoft Research's GraphRAG paper and a review paper on various uses of knowledge graphs: https://www.microsoft.com/en-us/research/blog/graphrag-unlocking-llm-discovery-on-narrative-private-data/

Securing your Kubernetes cluster_ a step-by-step guide to success !

KatiaHIMEUR1

Today, after several years of existence, an extremely active community and an ultra-dynamic ecosystem, Kubernetes has established itself as the de facto standard in container orchestration. Thanks to a wide range of managed services, it has never been so easy to set up a ready-to-use Kubernetes cluster. However, this ease of use means that the subject of security in Kubernetes is often left for later, or even neglected. This exposes companies to significant risks. In this talk, I'll show you step-by-step how to secure your Kubernetes cluster for greater peace of mind and reliability.

Encryption in Microsoft 365 - ExpertsLive Netherlands 2024

Albert Hoitingh

Accelerate your Kubernetes clusters with Varnish Caching

Thijs Feryn

Unsubscribed: Combat Subscription Fatigue With a Membership Mentality by Head...

Product School

Essentials of Automations: Optimizing FME Workflows with Parameters

Safe Software

Are you looking to streamline your workflows and boost your projects’ efficiency? Do you find yourself searching for ways to add flexibility and control over your FME workflows? If so, you’re in the right place. Join us for an insightful dive into the world of FME parameters, a critical element in optimizing workflow efficiency. This webinar marks the beginning of our three-part “Essentials of Automation” series. This first webinar is designed to equip you with the knowledge and skills to utilize parameters effectively: enhancing the flexibility, maintainability, and user control of your FME projects. Here’s what you’ll gain: - Essentials of FME Parameters: Understand the pivotal role of parameters, including Reader/Writer, Transformer, User, and FME Flow categories. Discover how they are the key to unlocking automation and optimization within your workflows. - Practical Applications in FME Form: Delve into key user parameter types including choice, connections, and file URLs. Allow users to control how a workflow runs, making your workflows more reusable. Learn to import values and deliver the best user experience for your workflows while enhancing accuracy. - Optimization Strategies in FME Flow: Explore the creation and strategic deployment of parameters in FME Flow, including the use of deployment and geometry parameters, to maximize workflow efficiency. - Pro Tips for Success: Gain insights on parameterizing connections and leveraging new features like Conditional Visibility for clarity and simplicity. We’ll wrap up with a glimpse into future webinars, followed by a Q&A session to address your specific questions surrounding this topic. Don’t miss this opportunity to elevate your FME expertise and drive your projects to new heights of efficiency.

How world-class product teams are winning in the AI era by CEO and Founder, P...

Product School

Recently uploaded (20)

To Graph or Not to Graph Knowledge Graph Architectures and LLMs

Epistemic Interaction - tuning interfaces to provide information for AI support

Elevating Tactical DDD Patterns Through Object Calisthenics

When stars align: studies in data quality, knowledge graphs, and machine lear...

PCI PIN Basics Webinar from the Controlcase Team

Software Delivery At the Speed of AI: Inflectra Invests In AI-Powered Quality

Assuring Contact Center Experiences for Your Customers With ThousandEyes

Key Trends Shaping the Future of Infrastructure.pdf

From Daily Decisions to Bottom Line: Connecting Product Work to Revenue by VP...

UiPath Test Automation using UiPath Test Suite series, part 3

Monitoring Java Application Security with JDK Tools and JFR Events

Kubernetes & AI - Beauty and the Beast !?! @KCD Istanbul 2024

Designing Great Products: The Power of Design and Leadership by Chief Designe...

GraphRAG is All You need? LLM & Knowledge Graph

Securing your Kubernetes cluster_ a step-by-step guide to success !

Encryption in Microsoft 365 - ExpertsLive Netherlands 2024

Accelerate your Kubernetes clusters with Varnish Caching

Unsubscribed: Combat Subscription Fatigue With a Membership Mentality by Head...

Essentials of Automations: Optimizing FME Workflows with Parameters

How world-class product teams are winning in the AI era by CEO and Founder, P...

Driving DITA off the Map

1. Driving DITA off the Map Jang F.M. Graat

2. Who’s talking ? • Jang F.M. Graat • Amsterdam • Part-time tech comms specialist (25+ years) • Full-time philosopher • Box ? What box ? • Addicted to challenge

3. Driving DITA off the Map Toward (Much) More Intelligent Information Disclosure

4. What’s the problem ?

5. Minimalism

6. Only what the user needs

7. One Size Fits All ?

8. Who is the user ?

9. What do they know ?

10. Progressive disclosure

11. Workﬂow diagram

12. Trouble-shooting

13. Organizing topics

14. Where to look ?

15. Outdated paradigm

16. Slightly better paradigm

17. Modern (lazy) paradigm

18. What is installed ? A B C D E F G H GUI a X X X X GUI b X X X GUI c X X library 1 X X X library 2 X X X X X X library 3 X X X X .NET X X X X SQL X X X PHP X X X X

19. Can users ﬁgure it out ?

20. User-side conﬁguration

21. Intelligent disclosure information elements (multiple versions) maps, indexes, cross-refs, search results product a product b product c

22. c X X X Dynamic toc, index, etc. information elements (multiple versions) a b

23. Dynamic topic linking information elements (multiple versions) a b c

24. Only what users need

25. Questions ? jang @ jang . nl