Open stephanieosan opened 7 years ago
Looking pretty good! I do have some notes on the content:
Looks good to me too! Just a couple comments:
1) Under "General content guidelines >> Formatting content"— in the first paragraph, maybe we encourage presenting a visual example where relevant next to that bulleted list of components? (Side note: the bulleted example on the github.io page isn't bulleting 😭 )
Present components of behavior, styling, use cases, etc as bullet points, to allow readers to skim content easily. Include an image or a live code example of those components as needed.
Example:
2) Under "General content guidelines >> Formatting content" —perhaps we should rewrite the first sentence to explain what's meant by "dynamic content" and "content 'snippets'"? Like, make clear up front that we're talking about a shortcut for content writers to pull standardized data (like our color palettes) into design manual pages without having to write things out.
3) Under "page components", we repeat the "language" and "dynamic content" sections that appear in General content guidelines. Should we take them out of one of the sections? Or do we want to leave as is?
I am making all of your suggested changes @ielerol and @sonnakim! The only one I was a little confused by/unsure about was your (2) Sonna. I'm totally down to change stuff if you think we should clarify more, but I'm not doing a good job of following which part I should change. Could you screenshot + provide a recommended sentence/words to add?
Thank you!!
Who has the power to do a final review and merge on this?
@stephanieosan Okay, here's what I've got! Please replace the highlighted sentence below:
with the bolded words here:
Use dynamic content, or shortcut references to data used site-wide, to simplify the process of documenting standards. Rather than writing out the hex number for a brand palette color, you could use a dynamic content reference to automatically pull that hex number into your design manual page. This eliminates the need to copy and paste the same content again and again or to update many separate pages if standards change over time.
@stephanieosan Could you make the content changes and I'll look into helping with the less changes. Looks like we could easily get this merged.
Less fix is ready for review => https://github.com/stephanieosan/design-manual/pull/1
@stephanieosan just wanted to bump the content change @sonnakim suggested. If you don't think you'll get to it I can try to find time today.
Additions
These content guidelines pages aren't included in the top nav, instead we've redesigned the footer to include a link to them there.
Changes
Future considerations
Review
Check out changes here: https://stephanieosan.github.io/design-manual/content-guidelines/content-guidelines.html