Classification API - Skills, Titles and Companies API features
Created Date | Mar 27, 2023 |
---|---|
Target PI | PI5 |
Target Release | |
Jira Epic | |
Document Status | Draft |
Epic Owner | @Nick Studt (Deactivated) |
Stakeholder | @Derek Nevins (Deactivated) @Abby Santos @Mark Taylor |
Engineering Team(s) Involved | Data Delivery, Micro |
PART 1
Customer/User Job-to-be-Done or Problem
When I need to access Lightcast Skills, Titles or Companies taxonomies or classifiers - I want to go to the same service (Classification API) which all other Taxonomies and Classifiers are also available - including LOT.
Value to Customers & Users
The benefit to customers is having a single service to serve up all Lightcast Taxonomies and Classifiers - this includes a single service to provide open access as well for Skills, Titles and LOT.
Value to Lightcast
Skills, Titles and Companies Services can be sunset - this will reduce costs of maintain these services and the duplicate taxonomy delivery approach associated with this. @Abby Santos - feel free to add further comments on the benefits/cost savings for your team.
Deprecating the skills, titles, and companies APIs allows the C&E team to only have one release pipeline for each of these, making the workflows much easier and allowing all downstream teams to adopt the same schema for taxonomies and the same code for classifiers.
Target User Role/Client/Client Category
Building this for all Lightcast Open clients as well as any clients who want to access any of the Lightcast Taxonomies or Classifiers via API.
Delivery Mechanism
Classification API
Success Criteria & Metrics
Skills, Titles and Companies endpoints are built out in the Classification API such that we can begin transitioning clients to the go-forward service.
Change log endpoints as needed to replicate what is available in the legacy services
Aspects that are out of scope (of this phase)
We will not bring the Related-Skills endpoint into the Classification API. This model is available in the Similarity API
PART 2
Solution Description
Early UX (wireframes or mockups)
<FigmaLink>
Non-Functional Attributes & Usage Projections
Consider performance characteristics, privacy/security implications, localization requirements, mobile requirements, accessibility requirements
Dependencies
Is there any work that must precede this? Feature work? Ops work?
Legal and Ethical Considerations
Just answer yes or no.
High-Level Rollout Strategies
Initial rollout to [internal employees|sales demos|1-2 specific beta customers|all customers]
If specific beta customers, will it be for a specific survey launch date or report availability date
How will this guide the rollout of individual stories in the epic?
The rollout strategy should be discussed with CS, Marketing, and Sales.
How long we would tolerate having a “partial rollout” -- rolled out to some customers but not all
Risks
Focus on risks unique to this feature, not overall delivery/execution risks.
Open Questions
What are you still looking to resolve?
Complete with Engineering Teams
Effort Size Estimate |
---|
Estimated Costs
Direct Financial Costs
Are there direct costs that this feature entails? Dataset acquisition, server purchasing, software licenses, etc.?
Team Effort
Each team involved should give a general t-shirt size estimate of their work involved. As the epic proceeds, they can add a link to the Jira epic/issue associated with their portion of this work.
Team | Effort Estimate (T-shirt sizes) | Jira Link |
---|---|---|
|
|
|