DevConf.CZ 2020 has ended
Back To Schedule
Friday, January 24 • 4:30pm - 5:25pm
Documentation with Efficient Downstreaming in Mind

Sign up or log in to save this to your schedule, view media, leave feedback and see who's attending!

Feedback form is now closed.
So now your project switched to modular documentation to let a downstream product reuse some content. How do you write the documentation now?

This is the story of the creation of an automated downstreaming for Eclipse Che, told to understand what makes a documentation reusable for real.

An efficient downstreaming is, of course, automated. Hopefully, few remains downstream: the downstreaming process itself, and downstream specific topics, like installation instructions or release notes.
Most importantly, the content of the upstream documentation should fit into the modular documentation format. You can translate and reshape most of the outline keeping upstream as it is. Same story for the substitution of group of words, like project name. Only for larger chunks of text, you may need to modify upstream.
Attendees can expect a presentation and discussion of ways to adapt upstream documentation to ease its reuse in downstream products.
Slides: https://themr0c.github.io/2020-01-efficient-downstreaming/

avatar for Fabrice Flore-Thébault

Fabrice Flore-Thébault

Technical Writer, Red Hat
free software believer, convinced ansible user, tech writer

Friday January 24, 2020 4:30pm - 5:25pm
A113 Faculty of Information Technology Brno University of Technology, Božetěchova, Brno-Královo Pole, Czechia

Attendees (28)