What Do We Need Documentation For? And if We Do, How Do We Make It Good?
We provide the motivation, a starting point, best practices, clear criteria, and practical advice to take your documentation to the next level while creating higher-quality documentation.
First of all, we do not concentrate to technical aspects of this topic. We think that the technical need is less compared to the other aspects. We focus on: why documentation? And if answered positively, how to make it a good one? In this talk we therefore concentrate to aspects in terms of content to provide needed knowledge and the right sense of perspective to you, to make you a good documentation writer.
First, Sandra will talk about the scope of different documentation types and will classify the TYPO3 extension/official TYPO3 documentation within a broader scope. Then she will underline the main reasons for documentation. Next she will give advices how to provide a good starting point for good documentation. Among them: best practices, useful criteria, advices to get your hands dirty in writing good documentation and own experiences. Also she will mention the problem of KI-created documentation and which threats can be triggered by it.