Skip to content

Improve documentation for technology selection decision makers #29

Description

@jrhender

In order to improve the ability of technology selection decision makers, such as CTOs or Software Architects, to assess whether or not the VC API implementation is suitable for their use cases and technology context, the documentation of this VC API implementation should be improved.

Note that this may not require necessarily adding additional Information; it may be more effective to change the structure and presentation of the information to make it easy to understanding.

The summary of the objective of this issue: Allow decision makers to understand quickly what the VC API implementation can do (what is in scope/out of scope, what it can do, what it can't do).

Example documentation:

Implementation steps:

  1. Move documentation to a github.io site (similar to the OWF TAC site https://tac.openwallet.foundation/)
  2. Improve documentation content

Documentation content:

  • Feedback section (how to request a feature or report a problem)
  • Link to other documentation

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    Status
    In Progress

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions