Product name | Team | Owner | Tech lead | Some link | Lifecycle stage | Tags |
---|---|---|---|---|---|---|
My product | ThatTeam | Cassie Cash | Someguy Someguyson | https://company.com/asdf | Production | backend |
Write an easy-to-follow guide or onboarding material for new users to help them quickly do something with the software.
List your most important commands here.
npm start
Description here.
Configurations that are required and/or can be edited, including for initial setup, if necessary.
Our online documentation can be found at:
- Website
- API docs
- Confluence (add link)
Source code for our repositories can be found at:
- Location 1 (add link)
- Location 2 (add link)
Please see the diagrams
folder.
We follow the Michael Nygard model for Architectural Decision Records.
Please see the adr
folder.
Visit the docs on Bump or see the api
folder.
Provide example payloads for all types of API requests or events that your system handles.
Description.
POST /doSomething
{
"key": "value"
}
Status 200
{
"key": "value"
}
Description.
{
"key": "value"
}
Specify how to run tests and describe what types of tests are conducted. Also, specify any manual validations that might be needed and how to do them.
Write how you have designed your solution, for example in terms of technical scaling, databases, network segregation, and so on. See SDLC safeguards section 2 for more on these requirements.
Something here.
Something here.
Something here.
Something here.
Something here.
Something here. For more, see Data Inventory
section above.
Something here.
Something here.
What information does this service log? Link to logs/log group.
Which dashboards exist? Is it easy to determine whether or not this microservice is working correctly by looking at the dashboard? Link to dashboards.
What are this microservice's key metrics?
Example metrics
- Language-specific metrics
- Availability
- SLA
- Latency
- Endpoint success/responses/response times
- Clients
- Errors and exceptions
- Dependencies
What alerts exist? Where do they report, on what thresholds? To whom? At what intervals?
See CHANGELOG.md
. Example: https://github.com/mikaelvesavuori/better-apis-workshop/blob/main/CHANGELOG.md
We have a risk-based remediation strategy, with monthly, or more frequent, reviews. We use the CVSS framework to prioritize the order in which discovered vulnerabilities are fixed.
We use the following software tooling/products/services to aid us in our work:
- Some Product
Please see SECURITY.md
for more. Example: https://github.com/mikaelvesavuori/better-apis-workshop/blob/main/SECURITY.md
Please see CONTRIBUTING.md
. Example: https://github.com/mikaelvesavuori/better-apis-workshop/blob/main/CONTRIBUTING.md
Please see CODE_OF_CONDUCT.md
. Example: https://github.com/mikaelvesavuori/better-apis-workshop/blob/main/CODE_OF_CONDUCT.md
Please see LICENSE.md
. Example: https://github.com/mikaelvesavuori/better-apis-workshop/blob/main/LICENSE.md