Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✍️ Write 'How to' for defining words (research/writing side) #82

Open
5 tasks
tatianamac opened this issue Feb 19, 2020 · 3 comments
Open
5 tasks
Labels
help wanted Good for external contributors Type · Documentation Improve documentation Type · Writing For definitions and/or documentation

Comments

@tatianamac
Copy link
Collaborator

tatianamac commented Feb 19, 2020

Improve documentation for defining words.
Use #70 for context.

  • Share common resources
  • Itemise different definition components (Avoid/Use Instead, etc) more fully
  • Give do's and don't's
  • Break down examples of specific definitions to illustrate nuance.
  • Explicitly determine style guide (preferably common English external one like CMoS to start, then build upon with customisations as needed, i.e., using International English)
@tatianamac tatianamac added help wanted Good for external contributors Type · Writing For definitions and/or documentation Type · Documentation Improve documentation labels Feb 19, 2020
@ovlb
Copy link
Collaborator

ovlb commented Feb 19, 2020

Shall this also include a style guide? I noticed that the quotes used aren’t uniform at all. I wrote a toll once that might be able to help us style them during render without having to nitpick in PRs: Typographizer JS (Haven’t really tested this in production anywhere, though 🙈)

@tatianamac tatianamac changed the title ✍️ Write ✍️ Write 'How to' for defining words (research/writing side) Feb 19, 2020
@tatianamac
Copy link
Collaborator Author

Yes, absolutely would include how to properly cite/quote (which will involve a "twin" frontend styling convention, which I love the idea of using Typographizer JS 🤓). Added as bullet point above.

@siawayforward
Copy link
Contributor

Interested in the research/documentation aspect of this and would love to pair with a coder for thinking through how the information would appear. Already put out chirps in Slack. Also, point of clarification please - is the following statement of understanding correct?
This is unlike the definition template for how to define a word/phrase, but rather a resource for what to consider while addressing the fields in defining a word/phrase for contributors.

Otherwise looking forward to this finally! Thanks again for making this so inclusive @tatianamac :)

@kkemple kkemple added this to the Improve Collaboration milestone Apr 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Good for external contributors Type · Documentation Improve documentation Type · Writing For definitions and/or documentation
Projects
Development

No branches or pull requests

4 participants