Living Documentation: Continuous Knowledge Sharing by Design

Martraire, Cyrille



Use an Approach Inspired by Domain-Driven Design to Build Documentation That Evolves to Maximize Value Throughout Your Development Lifecycle




Software documentation can come to life, stay dynamic, and actually help you build better software. Writing for developers, coding architects, and other software professionals, Living Documentation shows how to create documentation that evolves throughout your entire design and development lifecycle.





Through patterns, clarifying illustrations, and concrete examples, Cyrille Martraire demonstrates how to use well-crafted artifacts and automation to dramatically improve the value of documentation at minimal extra cost. Whatever your domain, language, or technologies, you don't have to choose between working software and comprehensive, high-quality documentation: you can have both.





- Extract and augment available knowledge, and make it useful through living curation



- Automate the creation of documentation and diagrams that evolve as knowledge changes


- Use development tools to refactor documentation


- Leverage documentation to improve software designs



- Introduce living documentation to new and legacy environments



Cyrille Martraire (@cyriux on Twitter) is CTO, co-founder, and partner at Arolla (@ArollaFr on Twitter), the founder of the Paris Software Crafters community, and a regular speaker at international conferences. Cyrille refers to himself as a developer, since he has designed software since 1999 for startups, software vendors, and corporations as an employee and as a consultant.




He has worked and led multiple significant projects, mostly in capital finance, including the complete rewriting of a multilateral trading facility of interest rate swaps. In most cases he has to start from large and miserable legacy systems.





He's passionate about software design in every aspect: test-driven development, behavior-driven development, and, in particular, domain-driven design.





Cyrille lives in Paris with his wife, Yunshan, and children, Norbert and Gustave.