Living Documentation: Continuous Knowledge Sharing by Design

Format: Hardback
Length: 480 pages
Publication date: 04 June 2019
Publisher: Pearson Education (US)

Software documentation is often seen as a necessary evil, but it doesn't have to be this way. In fact, documentation can be an invaluable tool for building better software. This concise guide introduces the concept of living documentation, which changes at the same pace as software design and development. From establishing business goals to capturing domain knowledge, creating architecture, designing software, coding, and deployment, living documentation covers all stages of the software development process.

The guide is filled with clarifying illustrations and concrete examples that demonstrate how to dramatically improve documentation at minimal extra cost by using well-crafted artifacts and judicious automation. Living Documentation is language- and technology-agnostic, meaning it can be applied to any software development project regardless of the programming language or technology being used.

One of the key concepts of Living Documentation is that it borrows powerful ideas from domain-driven design. This approach helps you customize the concepts and apply them to meet your changing documentation needs in your specific domain. By aligning documentation with the domain, you can ensure that it is more relevant, accurate, and useful to your team members.

Living Documentation also emphasizes the importance of collaboration and communication in the software development process. By involving stakeholders in the documentation process, you can ensure that everyone is on the same page and that the documentation accurately reflects the software's requirements and functionality.

In conclusion, software documentation can be a powerful tool for building better software. By adopting the concept of living documentation, you can create documentation that changes at the same pace as software design and development, is relevant to your specific domain, and is useful to your team members. With the right approach and tools, you can have the benefits of comprehensive, high-quality documentation without sacrificing the time and resources needed for software development.

Weight: 922g
Dimension: 186 x 239 x 28 (mm)
ISBN-13: 9780134689326