Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

How should we format writer's notes? I'm seeing a few different standards. Compare the quick start template with the tutorial template. The Quick start uses emoji and the tutorial template doesn't. #255

Open
barbaricyawps opened this issue Jul 18, 2022 · 5 comments
Labels
style question Questions for the style guide

Comments

@barbaricyawps
Copy link
Contributor

No description provided.

@camerons
Copy link
Member

I'm in favor of:

  • A limited set of known visual cues, such as standard emojis can help orient a reader.
  • Emphasis here is on "limited" and widely used emojis that users will quickly recognize and become familiar with.

This will likely require some group to take responsiblity for managing this limited set.

I'm okay with not having these emojis too.

@barbaricyawps barbaricyawps added the style question Questions for the style guide label Jul 27, 2022
@heykayla
Copy link

Deanna suggested looping in the people involved in creating the Quick Start Guide for their thoughts/ideas on why they chose the emojis they chose.

@heykayla
Copy link

heykayla commented Sep 20, 2022

Something to add to the discussion:
Embedded writer tips/notes are addressed in the Template Deliverables.

Embedded writing tips - You can provide some lightweight writing tips that provide some tips or hints about what kind of content the template user might choose to put in a section of the document. Put embedded writing tips in {curly brackets}. >

Should we continue this practice?

Related to #267

@heykayla heykayla reopened this Sep 20, 2022
@flicstar
Copy link
Contributor

flicstar commented Sep 21, 2022

Some discussion from the meeting 21 Sept:

  • We need to designate writing tips/notes and also placeholder/variables, and should probably use a different symbol for each.

  • Square brackets and angle brackets have been considered, but linting tools and the rendering stumbled over these.

  • Templates need to be accessible -> need to be mindful of this when using emoji. Also different emoji flavors.

  • Use curly brackets for writing tips, use something else for placeholders. Perhaps italics? But also, perhaps not.

  • Use curly braces for any content that is replaced with user's own text, or that they should delete. Optional: Designate using "Note:" or "Tip:" if required. We should define the allowable words like Note, Tip, Optional, Alert, Warning, etc.

  • Template should be as lean as possible. Writing tips should go in the guide rather than the template.

@heykayla
Copy link

Agreed to not use emojis

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
style question Questions for the style guide
Projects
None yet
Development

No branches or pull requests

4 participants