Update Copy Style Guide for Contributing Section

makerdao / community

Contains current and historical governance polls and executives used in the governance of the Maker Protocol. Previously contained a lot of other content which remains in the 'prior-cleanup' branch.

https://forum.makerdao.com/

GNU Affero General Public License v3.0

192 stars 161 forks source link

Update Copy Style Guide for Contributing Section #387

Closed amy-jung closed 4 years ago

amy-jung commented 4 years ago

The contributing section should improve contributor experience and onboarding. Guides should remove the barriers for community members to be part of the team, improve community resources, give and receive feedback, and grow the MakerDAO community.

Working Doc

Reference comments in #231

Update name to "Writing or Written Style Guide"
Update with grammar tools?
Move some content to different pages (Tooling or editor's guide)
Add content from Marcin's user doc: #134: MakerDAO documentation Framework needs refining

Project Planning Doc

Davidutro commented 4 years ago

Adding @aburban90's comment from the older issue(#231) here:

Add to Style Guide:

Whole Text Editors:
- Grammarly (https://app.grammarly.com/)
  - Mistake-Free Writing Editor
- HemingwayApp (http://www.hemingwayapp.com/)
  - Make writng bold and clear
Word and Phrasing Suggestions
- Thesaurus (https://www.thesaurus.com/
  - Single Word Suggestions
- Powerthesaurus (https://www.powerthesaurus.org/)
  - Phrase Suggestions
- WordHippo (https://www.wordhippo.com/)
  - Phrase Suggestions

aburban90 commented 4 years ago

Is there a working doc?

aburban90 commented 4 years ago

Live: https://github.com/makerdao/community/blob/master/contributing/style-guide.md

aburban90 commented 4 years ago

@amy-jung Naming options: Writing Style Guide [Picked this one for now] Community Style Guide Community Writing Style Guide

I think Writing Style Guide works... I am updating AMD Maintenance doc to match.

amy-jung commented 4 years ago

My raw notes:

https://hackmd.io/@rawhaus/HyOS_8xmL/edit