Johannes Dienst
&
Documentation plays a critical role in the evaluation, onboarding and adoption of your tool, but it feel like developer documentation is difficult to get right. In this session, Johannes Dienst will share his experiences revamping his product’s developer documentation and share some tips and advice for what worked to enhance the quality of the documentation and examples.
Inadequate developer documentation can be detrimental to your product’s success. Developers seek efficient problem-solving, and if your product fails to provide that, they will quickly move on.
Join me as I share my experience of revamping developer documentation at my current company. Initially, the documentation was subpar and barely functional for many developers. Onboarding was challenging, and existing users struggled to accomplish their tasks effectively.
This talk will delve into the stages of enhancing documentation quality, complete with real-world examples of our journey. Gain insights into structuring your documentation to meet your audience’s specific needs through segmentation. Discover the power of crafting precise learning objectives to streamline content focus. Additionally, I will demonstrate how adopting the Docs-As-Code approach can automatically ensure inclusive language, spelling accuracy, and stylistic consistency, resulting in an enjoyable reading experience.
Johannes Dienst is Developer Advocate at AskUI. His focus is on automation, documentation, and software quality.
Content is rarely a topic developers focus on, even though it is a critical aspect to what they build. CodeWord Conf is all about the combination of code and content.
Content is rarely a topic developers focus on, even though it is a critical aspect to what they build. CodeWord Conf is all about the combination of code and content.
Burke Holland will give us all the tips and tricks we need to get the most of out of generative AI using GitHub Copilot.
Moar Serverless will give you all the information you need to take advantage of serverless in your application development including new AI and edge capabilities.
Mrina Sugosh will take a look back at the history of and misconceptions around WYSIWYG tooling to better understand how these tools can help developers and designers in content creation.
