documentation icon indicating copy to clipboard operation
documentation copied to clipboard

build a process for checking jargon

Open kkowalsky opened this issue 9 years ago • 3 comments

Mapbox has a nice tool for de-jargon-ifying that could be implemented to make sure the writing style guide is being enforced

kkowalsky avatar Oct 17 '16 22:10 kkowalsky

would love this.

See also research about other checking: https://github.com/mapzen/mapzen-docs-generator/issues/20

rmglennon avatar Oct 17 '16 22:10 rmglennon

If we use something like this and keep our current decentralized docs process, we’re going to want to change the build process to make it less likely that a non-compliant docs source does not hold up an entire release.

migurski avatar Oct 17 '16 22:10 migurski

words to add:

  • company/organization names (OpenStreetMap for example)
  • software names (GitHub, Leaflet, etc.)
  • common terms (open-source vs. open source)

feel free to edit this comment to add more words to look out for!

kkowalsky avatar Nov 02 '16 18:11 kkowalsky