documentation
documentation copied to clipboard
build a process for checking jargon
Mapbox has a nice tool for de-jargon-ifying that could be implemented to make sure the writing style guide is being enforced
would love this.
See also research about other checking: https://github.com/mapzen/mapzen-docs-generator/issues/20
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.
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!