Skip to main content

Template

Short summary and and relevant context

Goals​

What was the purpose?

Design Decisions​

What choices were made? Why?

Historical Context​

Legacy code, compatibility/concerns?

Technical Constraints​

Infeasible or impossible goals? Limitations and other technical considerations?

Trade-Offs​

Pros/cons, weighed arguments, conclusions?

Evaluation​

Does this design meet all the requirements? Is it the simplest possible design given all of the above?

Alternatives​

Different approaches that were considered/not considered, (dis)advantages, matter of style?

See also​

  • Link to tutorial
  • Link to how-to guides
  • Link to references