thegooddocsproject / templates

Templates created by The Good Docs Project - for all your tech writing needs.
https://thegooddocsproject.dev/
Other
680 stars 170 forks source link

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 2 years ago

camerons commented 2 years ago

I'm in favor of:

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

I'm okay with not having these emojis too.

heykayla commented 2 years ago

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 commented 2 years ago

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

flicstar commented 2 years ago

Some discussion from the meeting 21 Sept:

heykayla commented 2 years ago

Agreed to not use emojis