Skip to content

Establish Five and a fake company as a narrative to facilitate docs comprehension #457

@leecalcote

Description

@leecalcote

Current Behavior

It can be a challenge to document, screenshot, and explain features without a set of pre-established actors - a pre-established story with fake users, teams, and organizations in which to explain functionality. Lucky for us, we have an opportunity to create a continuous narrative in Layer5 Docs by incorporating our mascot, Five, into our docs.

Implementation

  1. Develop a small narrative around Five, his team, surrounding teams, and organization. This narrative can be illustrative in explaining features like workspaces, environments, users, teams, roles and so forth.
  2. Publish this narrative in both the Kanvas and Cloud doc sets.
  3. Start infusing this narrative into the documentation. Open new issues to suggest and track where our mascot can be helpful in explaining concepts.
  4. A collection of Five illustrations that can be sourced where approrpriate - https://layer5.io/company/brand (bottom of page)

Example

Microsoft documentation uses "Contoso" as a fake organization to aid in the explanation of concepts throughout its product docs.

Image

Contributor Guide and Resources

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions