Crafting Docs for Success: An End-to-End Approach to Developer Documentation received a Merit Award in the UK Technical Communication Awards 2024.
The UK Technical Communication Awards recognize clear, concise, and effective information products that support users and demonstrate excellence in content design and delivery. The jury praised the book for its comprehensive structure, detailed content, and practical guidance.
The book was developed as a flexible, end-to-end blueprint for planning, writing, and scaling developer documentation. It was inspired by feedback received from the UKTC Awards jury in 2019 and brings together processes, examples, and resources based on real-world documentation leadership experience.
This is an impressive entry from the original planning stages, through design and structure to execution. The author is entitled to be satisfied with the product as a comprehensive and consistent manual.
Comprehensive and consistent… a great step-by-step approach.
Clear, very easy to read… exactly what you want to see when reading a book on developer documentation.
A lot of work has gone into creating this book. Taking the writing of it aside, which would have been a feat in itself, the hard work put into the project of creating developer documentation is incredible. Diana has done an amazing job on both counts.
The level of detail and the content in the book was impressive. The hard work that went into creating the developer docs is incredible; then to go one step further and write a book is amazing.
- Structure and navigation: Clear layout, logical flow, and easy to navigate
- Content: Comprehensive and detailed, relevant for API and developer documentation
- Tone and readability: Professional, accessible, and easy to follow
- Design: Well thought-out use of space and visuals
- Impact: Strong example of turning practical experience into a valuable resource
