cfpb / design-manual

⚠️ THIS REPO IS DEPRECATED ⚠️ A set of design principles and standards for the Consumer Financial Protection Bureau.
https://cfpb.github.io/design-manual/
Creative Commons Zero v1.0 Universal
98 stars 71 forks source link

Item introduction #416

Closed ajbush closed 8 years ago

ajbush commented 8 years ago

What is it?

V1 is looking to add its atomic element documentation to the DM for the use of other teams. Because the primary touchpoint with these elements is through the Wagtail CMS we have focused on the components that will be encountered there. This component is actually a grouping of smaller page components and therefore the page abides by the content guidelines as much as possible but has a few differences. This page will live in the "page components" section of the updated DM.

Item introduction

niqjohnson commented 8 years ago

(I volunteered to do the UI review of this one in lieu of @schaferjh.)

I understood what an item introduction is after reading the page, so 👍 there.

Overall, I wanted more specific language and examples on the page. I definitely get wanting to keep the explanation general so we're not too prescriptive on when to use an item introduction, but it took me a while to wrap my head around what exactly an item introduction is. Some changes that might help with that:

All that said, I still got what an item introduction is from what's there now, so I don't think any of those suggestions need to hold up launching the first version of this page.

nataliafitzgerald commented 8 years ago

@duelj @ajbush

Content feedback:

Design feedback:

schaferjh commented 8 years ago

Per @niqjohnson's feedback (thanks!), I suggest rewording the introduction to this item to read:

The item introduction component is a variation of the text introduction component used on pages found in filterable lists such as blog posts, press releases, or documents.

For the MVP version of this page, we're going to hold off on loading up on specific examples while folks try out all these new pages. We'll gather feedback and if they still feel necessary in a few months, compile examples.

@ajbush will be making some tweaks to the generic examples to make them clearer.

schaferjh commented 8 years ago

@ajbush Tweak to the Content guidelines -- update the spacing:

The optional subheader paragraph should be additive to the user experience. Most pages currently using this component do not use the subheader element.

If using the subheader paragraph, it should expand on the page title and help explain why the reader should care. No more than 2 sentences; 50 words.

ajbush commented 8 years ago

Updated!

schaferjh commented 8 years ago

👍 ready to publish!