Chapter 13. Design Documents

Be sincere; be brief; be seated.

—Franklin D. Roosevelt

In this chapter we introduce design documents and discuss their uses and the best practices surrounding them. Design documents are written descriptions of proposed and completed projects, big or small. Design documents serve as a roadmap for your projects and documentation of your accomplishments.

13.1 Design Documents Overview

Design documents are descriptions of proposed or completed projects. They record the goals, the design itself, alternatives considered, plus other details such as cost, timeline, and compliance with corporate policies.

Writing out what you are going to do forces you to think through the details. It forces you to plan. Having a written ...

Get Practice of Cloud System Administration, The: DevOps and SRE Practices for Web Services, Volume 2 now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.