TEMPLATE: Documentation - make a copy
Platform URL | https://[enterprise].cvtr.io/v2/…. |
---|---|
API Endpoints |
….. |
Epic |
|
Document status | DRAFT |
Document owner | @Danny Hannah @Adam Carter |
Technical writers |
|
Related Content |
|
Feature Overview
Provide an overview of the feature and describe:
users who can access the page on the platform
widgets available to the users
functionalities available: Listing page, add, edit, delete, download etc. with screenshots
for add/create modals, provide details of the fields to be submitted to complete the action
E.g.
Name | Required | Notes |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
search and filter options available on table columns, if any
custom table views, pagination, if available
Summary
Summarise the functionalities in a table
Functionality | User Story | |
---|---|---|
1 |
|
|
2 |
|
|
3 | Table Filtering | Allows the user to filer the table values using column names |
4 | Custom Tables | A user can add, remove and reset columns for custom table |
User Permissions
Mention if access needs to be enabled for any user roles and attach the user matrix.