Closed PaulKinlan closed 10 years ago
Comment by PaulKinlan Tuesday Apr 29, 2014 at 21:01 GMT # Sample: Friday Sep 13, 2013 at 22:58 GMT
My thought at the time was that it is important enough in these two docs to send people to other areas of our site.
Paul, I feel like in general all of the call outs (e.g. Takeaways, Remember, and this one) are too prominent. Our docs should read live a novel... a long, consistent narrative with a few subtle "call outs" every so often.
I think these are good examples:
http://gameprogrammingpatterns.com/architecture-performance-and-games.html http://www.html5rocks.com/en/tutorials/webcomponents/shadowdom/
I personally find it difficult to read most of our articles in one sitting because the "call outs" break the narrative and in general ar visually distracting. What do you think?
I've mentioned this before, and in general, you see to like the status quo, so perhaps we need to have a longer in-person conversation about this.
On Fri, May 9, 2014 at 6:52 AM, Paul Kinlan notifications@github.comwrote:
https://github.com/PaulKinlan Comment by PaulKinlan https://github.com/PaulKinlan *Tuesday Apr 29, 2014 at 21:01 GMT # Sample: Friday Sep 13, 2013 at 22:58
GMT*
My thought at the time was that it is important enough in these two docs to send people to other areas of our site.
— Reply to this email directly or view it on GitHubhttps://github.com/google/WebFundamentals/issues/289#issuecomment-42667889 .
We have a lighter call out option in the style guide that we should use more liberally.
On the subject of takeaways I feel like they should be very prominent at the start of the article but we should only have one in the entire article.
Some of the issue that we have right now is our articles are waaaaaayyyyy to long. On 10 May 2014 06:16, "Max Heinritz" notifications@github.com wrote:
Paul, I feel like in general all of the call outs (e.g. Takeaways, Remember, and this one) are too prominent. Our docs should read live a novel... a long, consistent narrative with a few subtle "call outs" every so often.
I think these are good examples:
http://gameprogrammingpatterns.com/architecture-performance-and-games.html http://www.html5rocks.com/en/tutorials/webcomponents/shadowdom/
I personally find it difficult to read most of our articles in one sitting because the "call outs" break the narrative and in general ar visually distracting. What do you think?
I've mentioned this before, and in general, you see to like the status quo, so perhaps we need to have a longer in-person conversation about this.
On Fri, May 9, 2014 at 6:52 AM, Paul Kinlan notifications@github.comwrote:
https://github.com/PaulKinlan Comment by PaulKinlan https://github.com/PaulKinlan *Tuesday Apr 29, 2014 at 21:01 GMT # Sample: Friday Sep 13, 2013 at 22:58
GMT*
My thought at the time was that it is important enough in these two docs to send people to other areas of our site.
— Reply to this email directly or view it on GitHub< https://github.com/google/WebFundamentals/issues/289#issuecomment-42667889>
.
— Reply to this email directly or view it on GitHubhttps://github.com/google/WebFundamentals/issues/289#issuecomment-42732123 .
Issue by Meggin Tuesday Apr 29, 2014 at 20:50 GMT # Sample: Friday Sep 13, 2013 at 22:58 GMT Originally opened as https://github.com/PaulKinlan/WebDocs/issues/141
I really like the Related information sections, like the one that is in Create Your Content and Structure to find out more about creating amazing forms. But I do think the styling is disruptive to the main flow of the content. It's related-- not primary, and shouldn't break the primary flow.