template.adoc

Feature Name

Table of Contents

• Summary
• Motivation
• Design
• Drawbacks
• Alternatives
• Unresolved Questions

Summary

One paragraph explanation of the feature.

Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?

Design

This is the bulk of the design document. Explain the design in enough detail for a user to understand and for an expert to implement. This should get into specifics and corner-cases, and include examples of how the feature is used.

Drawbacks

Why should we not do this?

Alternatives

What other designs have been considered? What is the impact of not doing this?

Unresolved Questions

What parts of the design are still TBD?