Skip to content

A high-level intuitive introduction to Cat-VRS for lay researchers and project managers #139

@DanielPuthawala

Description

@DanielPuthawala

It has been repeatedly observed that participation in GKS product development, like Cat-VRs generally seems to require endurance of a considerably steep learning curve. On the other hand, this requirement is antithetical to outreach to potential adopters and contributors in project management and strategic decision-making roles, who often possess the time and/or expertise to make sense of our technical documentation.

Therefore, it has been suggested that we develop documentation and/or supplementary resources in order to provide such an audience with an intuitive high-level overview of the Cat-VRS development project and product. There are a number of suggestions made so far to effectuate such a guide. These will be incorporated as sub-issues beneath this umbrella.

Suggestions include:

  • A short 5-10 minute youtube video explaining the project at a high level.
  • Text page version of the same with a a high incidence of visual aids (a 5-minute read)
  • It was suggested to utilize ChatGPT to help us rephrase technical jargon into intuitive terminology for the lay audience.
  • It was suggested to have figures that parallel those in our technical documentation, such that once someone gets the intuition and graduates to the technical documentation they will be presented with our technical terms already possessing an intuition for what they mean.
  • It was also observed that the Beacon documentation is entirely split across two parallel sites, one of which provides the intuitive project overview, and the other of which presents the technical documentation, demonstrating a model that we may (or may not) wish to emulate.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions