Brief Project Overview (brief as it should be known)
(Referenced to existing documentations is highly encouraged for the purpose of keeping this document up to date)
New component capabilities for Guilin, i.e. the functional enhancements, if applicable
New or modified interfaces
If they are modified, are they backwards compatible?
Interface naming (point to an example)
Consumed API from other projects
Project | API Dependency | Notes |
|---|---|---|
Published API
Project | API | Notes |
|---|---|---|
Reference to the interfaces.
(Reference to the the swagger.json file(s) whenever possible)
What are the system limits?
.
Involved use cases, architectural capabilities or functional requirements.
Listing of new or impacted models used by the project (for information only).
(list all the relevant Jira tickets)