...
Background & Business Value
In order to use the Teams feature, we need to transfer the existing Functional Accounts into Team accounts. This transition will require coordination with all the development teams that have already created functional accounts. We will also need to development documentation for the switch over, along with redeveloping documentation on how to create and manage accounts.
Goals
- Plan Transition Process
- Determine steps and control points
- Develop Transition Documentation
- Redevelop New User Documentation
Assumptions
Out of Scope
Requirements
| Ticket(s) | Title | User Story | Priority | Notes |
|---|
| Documentation - Create Company Account | Documentation - Create an Application with a Company | flushed out with reasoning (how companies provide a shared application for backups)Team Account | As a Developer Portal User, I would like a How To Create a Team Account. | | Status |
|---|
| colour | Green |
|---|
| title | must have |
|---|
|
| - Add a new documentation page: Documentation > Developer > Creating Your Team
- Should include info on how to Manage a Team.
- This should information about why Teams are Great and our Policies around them.
- Shared Maintenance of Applications
- Applications belong to groups and not people
- Application Access Request forms will need to come from Groups/Teams/Departments and not individuals
- Potential Future Security Policy: We may not grant Prod access to individual / proof-of-concept accounts
|
| Documentation - Create an Application with a Team | As a Developer Portal User, I would like a How to Create an Application | | Status |
|---|
| colour | Green |
|---|
| title | must have |
|---|
|
| - This might be a part of the above page: Documentation > Developer > Creating Your Team
- This should have information about how Applications are owned by Teams
- It should also include information on Data Access Reqeusts (currently, the Box Data Access Request Template).
- This might be a Documentation > Developer > Creating an Application page which focuses on both creating the application and Data Access Request Process.
|
| Documentation - Update "New User" Docs | As a Developer Portal User, I would like a Quick Start Guide. | | Status |
|---|
| colour | Green |
|---|
| title | must have |
|---|
|
| - We should rework the "Getting Started" pages, especially Creating Your First App to talk briefly about the difference between Proof-of-Concept applications and Team applications. The Quick Start Guide shouldn't ask people to create a Team first; but instead should focus on creating a Proof-of-Concept app. But, the Team stuff should be mentioned.
- Any place where the Functional Accounts are mentioned should be updated with Team Account information instead.
|
| Documentation - Transition from Functional Account | As an existing Functional Account User, I would like a page which describes the process I am going to need to take in order to transfer my Functional Account and it's Applications over to a Team. | | Status |
|---|
| colour | Green |
|---|
| title | must have |
|---|
|
| - Add a new documentation page: Documentation > Teams > Transitioning from a Functional Account to a Team.
- Should be a timeline of
- When the API Team will contact Functional Account Owners
- What we will be asking for
- Team Names
- Coordinated time we can perform the migration
- What we expected to get back and in what timeframe
- What will happen when their Application is migrated to the new Team
- New API Keys will be generated for the new Application
- They will need to put the new keys in place within a reasonable time frame so we can close out the old API Keys
- Be sure to include a background on how this is going to be soo much better than before and you will love it
|
| Create Company AccountsTeam Accounts | As a API Team member, I will need the ability to create Team accounts for the Functional Account Users. Since this will be confusing for them, we need to communicate the changeover process to them and be able to handle any stumbling blocks they might have with our own tool set. | | Status |
|---|
| colour | Green |
|---|
| title | must have |
|---|
|
| - Generate list of functional accounts and email group about creating company accounts.See
- should say: Once you've created your company account send support@developer.ucsb.edu an email so we can move your applications overs
| Move applications | - We will need to email this group with the same information that will be in Documentation - Transition from Functional Account.
- Will need to use @apibot commands for creating Teams. (Slack Commands to Manage Teams Requirements)
|
| Move applications | As a API Team member, I will need the ability to create Applications associated with Team accounts. Since this will be confusing for them, we need to communicate the changeover process to them and be able to handle any stumbling blocks they might have with our own tool set. | | Status |
|---|
| colour | Green |
|---|
| title | must have |
|---|
|
| - This will most likely create new API Keys, so we will need to coordinate the move on their schedule
| Drop Functional Accounts- create the "duplicated applications" for them and give Functional Account Users enough time to update their application to use the new API Keys.
- Will need to use @apibot commands for creating Teams. (See Slack Commands to Manage Teams Requirements)
|
| Drop Functional Accounts | AS a API Team member, I will need to remove unused Functional Accounts to clean out the system. | | Status |
|---|
| colour | Green |
|---|
| title | must have |
|---|
|
| - More of a reminder checklist item. This should be done as part of the Transition of each Team (see Documentation - Transition from Functional Account)
- Remove from system once no applications are associated with them
|
|
|
|
|
|
...