Skip to content

Fidel Docs variability of terms developer, publisher, account  #88

@taboca

Description

@taboca

Disclaimer — This feedback is based on a first reading experience, when I found Fidel Docs as part of an interview process; I decided to annotate some points— things I may perceived as ambiguous. Keep in mind that it's my own view and not exactly a problem in the documentation.

The context

  • The notion of account is presented to the developer, right upfront

Screen Shot 2020-04-11 at 15 03 59

The problem

As the developer reads the document, she will stumble at terms like:

  • publisher
  • publisherId
  • accountId
  • developer

Eventually the association between publisher and account is made.

For example at https://docs.fidel.uk/offers/offer-object section:

Screen Shot 2020-04-11 at 15 11 15

For example at https://docs.fidel.uk/offers/create-offer section:

Screen Shot 2020-04-11 at 15 11 48

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions