Technical guides must provide clear guidance while taking into account a variety of variables that may be beyond the author's control, which can lead to confusion should they address such issues without a high degree of consistency (or neglect to address them at all).
The purpose of this document is to provide clear guidance on how SEPS technical guides should be read / written.
Patterns beginning with the less-than symbol (<) and ending with the greater-than symbol (>) should be treated as contextual variables. Read the content between these two symbols to determine what the author is referencing based on context, then replace the entire pattern with the appropriate value.
For example:
<domain.name> in the context of this wiki should be replaced with wiki.seps.dev.sweet-e-cloud-<short-company-name> in this context of SEPS Cloud should become sweet-e-cloud-seps.Technical guides are to be written for public use. This means that certain details specific to SEPS internal operations must be omitted to avoid confusion.
For example: