Comments (5)
Cross posting my comment in the PR above (#76 (comment)) here – note that I'm a frequent user of both Hemingway and Grammarly, and encourage editors to use them.
I agree with the intent, but think an over-reliance on Hemingway is detrimental to the readability and clarity of this doc.
I find that following Hemingway's suggestions too closely leads to a succession of tiny sentences that can read as quite dry, and breaks the flow of otherwise very readable content. In one of the sentences, all jargon was removed in an undesirable lossy rewrite.
My guidance is to use Hemingway sparingly, and take its suggestions for what they are: suggestions.
👍🏻 It's useful to avoid very long sentences, repetitions, and spot passive voice that would read better as active.
👎🏻 It warns about jargon that's actually important in our context: technical reports are aimed at experts who rely on this vocabulary to derive precise meaning.
(Grammarly allows to specify the target audience, tone, level of formality… I personally find it better than Hemingway for professional writing like technical proposals, and still use Hemingway for blog posts)
from community-group.
That's fair. I wasn't necessarily saying we needed to use Hemingway. The purpose was to simplify the language a little bit, and I know those tools have helped me, so it was just a suggestion to consider a tool. I'm fine if we want to use just Grammarly!
from community-group.
I'm going to start running the spec through hemingwayapp.com one section at a time.
from community-group.
My five cents: We are trying to collaborate in between various disciplines here and from my personal experience i recommend, trying to be as precise as possible. I think, once we implemented a common language it will be beneficial—how to reach that is a different story on it's own.
So this is rather a matter of glossary but i would love to see maximum of inclusiveness as possible over here (heart)
from community-group.
Decision
We’ll pay attention to write the spec in a way that it remains understandable and clear for everyone.
We’re closing this issue for now, but may reopen it in the future if needed.
from community-group.
Related Issues (20)
- Specification / recommendation for custom types HOT 4
- Token Operations
- The $ property name prefix should be unnecessary with a well-structured schema HOT 10
- [Discussion]: How to transform composite tokens HOT 5
- Transition token documentation issue HOT 1
- Suggestion: colorList type for DataViz HOT 6
- Most recent edition (07/2023) missing from main page on w3c community group HOT 1
- A comment about history of design tokens HOT 2
- Type: Text alignment HOT 12
- Custom Types / Interpritations HOT 2
- Is there a way to still include boolean and string type functionality? HOT 1
- Be explicit about whether or not empty groups are allowed HOT 5
- Alias $type inheritance? HOT 7
- [Meta] Do functions/transforms happen before tokens.json (i.e. to generate it)? Or within tokens.json? HOT 4
- Multiple values - Array type HOT 3
- Toughts on the Use of "$" Prefix in the DTCG Token Standard HOT 8
- Are references generally allowed in arrays? HOT 1
- Dimension type expanded unit types HOT 5
- How library and tooling authors do keep track of conformance and changes? HOT 5
- $type: cubicBezier HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from community-group.