Speaker
Description
The talk hopes to answer the following questions:
- How to restructure documentation from absolute chaos?
- How can documentation frameworks help?
- What requirements do open source software documentation have that are different from other documentation?
The talk will address documentation, its usefulness in product development, and the problems that exist in producing good documentation.
While doing so, the talk hopes to introduce a couple of popular documentation frameworks and how they can help solve the documentation problems that we face.
What audience can learn
The talk is intended for a beginner audience, specifically for beginners to the open source community and documentation requirements in such an environment. However, it can be suitable for anyone interested in learning about documentation approaches and applying them.
Biography
Keirthana T S is a technical author at Canonical. She has overall 14 years of industry experience and she has been involved in creating software product documentation for almost 10 years now. Her areas of interest are information architecture, content consistency and standards. She lives in Bangalore, India.
Summary
This lightning talk aims to talk about two of the most popular documentation approaches (Darwin Information Typing Architecture (DITA) and Diataxis), their usefulness in product documentation and their suitability in open source software documentation.
Difficulty level | Begineer |
---|