docs icon indicating copy to clipboard operation
docs copied to clipboard

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

Open leecalcote opened this issue 9 months ago β€’ 4 comments

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

leecalcote avatar Mar 14 '25 16:03 leecalcote

@leecalcote can you assign me this one?

itsPronay avatar Apr 03 '25 13:04 itsPronay

Sounds great. Thanks much for jumping in and volunteering. In an effort to help guarantee your success in undertaking assignment of the issue, will you:

  1. confirm that you're able to build the project, specifically, the components necessary to resolve this issue.
  2. confirm the approach you intend to take to resolve the issue - a draft of the narrative would be great.

leecalcote avatar Apr 03 '25 19:04 leecalcote

I want to work on it kindly assign me this

Souradip121 avatar Apr 07 '25 12:04 Souradip121

@Souradip121, See https://github.com/layer5io/docs/issues/457#issuecomment-2776687005

leecalcote avatar Apr 07 '25 16:04 leecalcote