[aio_button align=”none” animation=”none” color=”blue” size=”small” icon=”edit” text=”Vortrag bewerten” relationship=”dofollow” url=”/t4at-2016-feedback/?session_title=Continuous+Documentation+–+Open+Automated+Documentation+for+the+Age+of+DevOps”]
Even before the Agile Manifesto boldly and truthfully proclaimed that working software is to be valued over comprehensive documentation, documentation was the stepchild of ALM and of agile processes even more so. Effectively and efficiently communicating software architectures and their runtime environment to all stakeholders of a project, even to those who do not accept code as documentation and should not have access to – for example – CI servers, remains a challenge. The beautiful documents and/or wiki pages produced manually are often obsolete after a very short time, as our release cycles shrink from months and weeks to days and sometimes hours.
The good thing is, that in the Age of DevOps (capital letters intended) the progress of automation in the application lifecycle management and cross-functional development teams already provide a lot of the information that is needed for documentation and that’s what our open source project Continuous Documentation is all about: Based on the arc42 (www.arc42.org) software architecture framework, the goal is to automatically extract documentation from the artefacts of Continuous Integration/Continuous Delivery processes: Code (DoC), configuration management information like Docker files and Puppet manifestos (DoS) and from (semi-) automated tests. (DoT), to transform it into structured, human-readable and wiki-based documentation and to use this information to enable change management processes across the organization. There are of course thousands of tools to produce software and to “do” DevOps.
Our focus currently is the JVM on Linux and the toolsets provided by the Atlassian and Redhat ecosystems. Our goal is to keep our architecture open and portable, so that others may add to or find different use cases for it. The core of this project is a discussion about best practices: How can we organize our work to facilitate automation and reduce redundancy even further. The presentation gives an overview and a demo of the current state of the project, the ideas behind it and our plans for the future. First modules will have been released at the end of QI 2016, so check out our homepage (www.networkedassets.com/opensource) for updates.
Jörg Mueller-Kindt (Twitter, LinkedIn, XING) is the CEO of NetworkedAssets, specializing as an Atlassian Expert and RedHat Advanced Business partner on JVM software architectures on Linux and the technical aspects of DevOps automation. Joerg Mueller-Kindt has 20+ years of experience in the service-provider and telecommunications industry. He is a Certified Scrum Master, a registered Prince2 Practitioner and an ITIL Practitioner and he still spends most of his time to explain what it actually is he is doing for a living.