Skip to content

API Description Review Findings # #565

Description

@jillLovato

Problem description
CAMARA Outreach team is reviewing all API descriptions on the CAMARA website using a checklist.

Possible evolution
In case of findings an issue is opened to ask the Sub Project to enhance the API description in the Wiki, and then open an issue at the Marketing repo so that the Outreach team then can update the website.

Alternative solution

Additional context

Findings from Quality on Demand:

  • "SubProject Wiki:” → “Sub Project Wiki:”.
  • Bold the use case names and add relevant GSMA Use Case Library links.
  • Reformat benefits as bold benefit name + description.
  • Rewrite the final benefit bullet for consistency, for example: Operational Efficiency: Reduce costs and simplify QoS management for API customers.
  • Optional: standardize naming from “Quality-On-Demand” to “Quality on Demand”
  • Verify the image is a use-case/value visual, not only a generic illustration.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions