About Design Docs

This article was originally published on bmf-tech.com . Overview I researched about Design Docs. What are Design Docs Design Docs are documents for software design. They do not have a fixed format and are written in a way that is meaningful to the project. Design Docs have several benefits in the development process, such as: Identifying design issues and reducing rework Building consensus on design Organizing and confirming cross-cutting concerns Sharing insights from senior engineers Although there is no specific format, it is recommended to clarify the context, scope, goals, and non-goals of the design. The length of the document should be short enough for busy people to read quickly. Whether or not to write a Design Doc depends on whether the benefits of writing it outweigh the costs of maintaining it. Design Docs have the following lifecycle: Creation and iteration (re-editing the document) Review Implementation and iteration (updating the document) Maintenance (updating the docum