2022-08-26 18:41:48 +02:00
|
|
|
---
|
|
|
|
|
title: Example
|
2023-02-02 12:59:45 +01:00
|
|
|
description: Short description
|
2022-08-26 18:41:48 +02:00
|
|
|
tags:
|
|
|
|
|
- content-manager
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Example doc
|
|
|
|
|
|
|
|
|
|
## Summary
|
|
|
|
|
|
2022-09-06 14:22:42 +02:00
|
|
|
_Description of the software system / component._
|
2022-08-26 18:41:48 +02:00
|
|
|
|
|
|
|
|
## Detailed design
|
|
|
|
|
|
|
|
|
|
- _Explaining the software design and reasoning._
|
|
|
|
|
- _Api specifications._
|
|
|
|
|
- _Benchmarks_
|
|
|
|
|
- _Add necessary diagrams and code examples._
|
|
|
|
|
- _Think about edge-cases and include examples._
|
|
|
|
|
|
|
|
|
|
## Tradeoffs
|
|
|
|
|
|
|
|
|
|
_What potential tradeoffs are involved with this system/implementation._
|
|
|
|
|
|
|
|
|
|
- _Complexity._
|
|
|
|
|
- _Limitations of the feature itself._
|
|
|
|
|
- _How does this proposal integrate with the current features implemented._
|
|
|
|
|
|
|
|
|
|
## Alternatives
|
|
|
|
|
|
|
|
|
|
_What other approaches did we consider?_
|
|
|
|
|
|
|
|
|
|
## Resources
|
|
|
|
|
|
|
|
|
|
- _Link to product documents._
|
|
|
|
|
- _Link to user documentation._
|
2022-09-06 14:22:42 +02:00
|
|
|
- _Any useful research used for it_
|
