carbon-design-system / carbon-platform

The "next" version of the Carbon Design System website, as a platform.
https://next.carbondesignsystem.com
Apache License 2.0
22 stars 5 forks source link

Update Copy #1140

Closed mjabbink closed 1 year ago

mjabbink commented 1 year ago

https://next.carbondesignsystem.com/about-carbon/how-carbon-works#the-carbon-ecosystem

current

The Carbon ecosystem

Carbon is a system of systems. At the epicenter lies the core system, with elements, assets, code, design kits, and guidelines intended as a base for the widest variety of situations. These assets are open source and can be easily extended or adapted.

Teams at IBM also create local systems that depend on and extend the core system for specific use cases. For example, Carbon for IBM.com is a local system that specializes in an editorial experience, whereas Carbon for IBM Products provides assets and guidance specific to the product experience.

Some local systems are open source while others require IBM employee authentication to view.

It is recommended that you start with the core system and whichever local systems are most relevant to your team. Catalogs for components, patterns, functions, and templates allow you to explore everything Carbon has to offer, with filters to find exactly what you need.

If you’re ready to get started with Carbon, check out our guidance for designing and developing

mjabbink commented 1 year ago

expected

The Carbon ecosystem

Carbon is a system of systems. At the epicenter lies the core system, with elements, assets, code, design kits, and guidelines intended as a base for the widest variety of situations. These assets are open source and can be easily extended or adapted.

Teams at IBM also create local systems that depend on and extend the core system for specific use cases. For example, Carbon for IBM.com is a local system that specializes in an editorial experience, whereas Carbon for IBM Products provides assets and guidance specific to the product experience. Some local systems are open source while others require IBM employee authentication to view.

It is recommended that you start with the core system and whichever local systems are most relevant to your team. Catalogs for components, patterns, functions, and templates allow you to explore everything Carbon has to offer, with filters to find exactly what you need. If you’re ready to get started with Carbon, check out our guidance for designing and developing

. . . . In the first paragraph, there could be mention of contributing back to the system

e.g.

.... These assets are open source and can be easily extended or adapted and also reused by other teams in the ecosystem

mjabbink commented 1 year ago

@aubrey-oneal @jeanservaas

The main point of this (as most of my copy edits) is the continued use of hard returns when not necessary.

The below sentence is a continuation of the preceding paragraph. It does not need to be its own sentence between two paragraphs.

e.g. “Some local systems are open source while others require IBM employee authentication to view.”

aubrey-oneal commented 1 year ago

Hi @mjabbink , in this case I would not take out the carriage return. In my content practice I follow several guidelines and the Content hierarchy guidelines that Tom has written does such a great job of ensuring that the content we write is scannable. i.e. Content hierarchy 1d: Where relevant, headings, subheadings, tabs, bullet-point lists, field labels, and so on are used to break up content and to help users quickly scan the page.

Here is the link (pasting in full because it doesn't always work as expected) https://pages.github.ibm.com/cdai-design/pal/content/content-heuristics/#1)-content-hierarchy

We are also including more information and methods on this in the new UX writing course. For example, this page illustrates common reading patterns and discusses that, since people often scan a page, the writer should "Include the most important points in the first sentence or two of any section." I deemed the point about IBM authentication important enough to warrant its own section so that it wouldn't be hidden at the end of a paragraph (burying the lede).

The return helps break up the new concept of what a local system is and who is able to access them. This is something I want to really highlight because it impacts internal and open source users very differently.

I'm definitely open to additional suggestions (for example I merged your last suggestion on taking out a return because the point I was highlighting wasn't so important as this one.) I'll also make sure to give you a better chance to review content before it goes into redlining and production.