strapi/docs/docs/example.md
2022-09-06 14:22:42 +02:00

725 B

title tags
Example
content-manager

Example doc

Summary

Description of the software system / component.

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.
  • Any useful research used for it