Comments on: What components go into a style guide? http://janetclarey.com/2007/11/04/what-components-go-into-a-style-guide/ Spinning the Social Web Sat, 21 Jan 2012 02:24:00 +0000 hourly 1 http://wordpress.org/?v=3.3.1 By: Tyson http://janetclarey.com/2007/11/04/what-components-go-into-a-style-guide/comment-page-1/#comment-4098 Tyson Wed, 24 Feb 2010 03:46:45 +0000 http://janetclarey.com/?p=417#comment-4098 I'm on the hunt for this as well - specifically for a large corporate organisations... what are other organisations doing? have been asked to define "Best Practice" in conjunction with a style guide... right down to timings, text size, etc.. I'm on the hunt for this as well – specifically for a large corporate organisations… what are other organisations doing? have been asked to define “Best Practice” in conjunction with a style guide… right down to timings, text size, etc..

]]> By: Cathy Moore http://janetclarey.com/2007/11/04/what-components-go-into-a-style-guide/comment-page-1/#comment-2511 Cathy Moore Tue, 06 Nov 2007 13:58:10 +0000 http://janetclarey.com/?p=417#comment-2511 And here's another resource: William and Kit Horton have a set of Word templates you can use to standardize design documents: http://www.horton.com/html/elformsword.aspx And here’s another resource: William and Kit Horton have a set of Word templates you can use to standardize design documents:

http://www.horton.com/html/elformsword.aspx

]]> By: Cathy Moore http://janetclarey.com/2007/11/04/what-components-go-into-a-style-guide/comment-page-1/#comment-4842 Cathy Moore Tue, 06 Nov 2007 13:58:00 +0000 http://janetclarey.com/?p=417#comment-4842 And here's another resource: William and Kit Horton have a set of Word templates you can use to standardize design documents: http://www.horton.com/html/elformsword.aspx And here’s another resource: William and Kit Horton have a set of Word templates you can use to standardize design documents:

http://www.horton.com/html/elformsword.aspx

]]> By: Cathy Moore http://janetclarey.com/2007/11/04/what-components-go-into-a-style-guide/comment-page-1/#comment-2510 Cathy Moore Mon, 05 Nov 2007 14:35:56 +0000 http://janetclarey.com/?p=417#comment-2510 I just ran across a style guide for charts and other graphics: http://www.sapdesignguild.org/resources/diagram_guidelines/index.html I'm not too keen on their suggestion that we use graphics for "decoration" but other recommendations seem solid. I just ran across a style guide for charts and other graphics:

http://www.sapdesignguild.org/resources/diagram_guidelines/index.html

I’m not too keen on their suggestion that we use graphics for “decoration” but other recommendations seem solid.

]]> By: Cathy Moore http://janetclarey.com/2007/11/04/what-components-go-into-a-style-guide/comment-page-1/#comment-4841 Cathy Moore Mon, 05 Nov 2007 14:35:00 +0000 http://janetclarey.com/?p=417#comment-4841 I just ran across a style guide for charts and other graphics: http://www.sapdesignguild.org/resources/diagram_guidelines/index.html I'm not too keen on their suggestion that we use graphics for "decoration" but other recommendations seem solid. I just ran across a style guide for charts and other graphics:

http://www.sapdesignguild.org/resources/diagram_guidelines/index.html

I’m not too keen on their suggestion that we use graphics for “decoration” but other recommendations seem solid.

]]> By: Cathy Moore http://janetclarey.com/2007/11/04/what-components-go-into-a-style-guide/comment-page-1/#comment-2509 Cathy Moore Mon, 05 Nov 2007 14:06:21 +0000 http://janetclarey.com/?p=417#comment-2509 A great resource on online writing style is Microsoft's Manual of Style for Technical Publications: http://www.microsoft.com/mspress/books/6074.aspx While it doesn't cover instructional design, it would help standardize editorial style. For the "living document" aspect, I'd suggest a wiki. Tiddlywiki is easiest to use and naturally supports tiny entries like you find in a style guide, but the last time I checked it can be edited by only one person. A centralized library of assets could help, too. It could be as simple as storing all images in one spot on the intranet (rather than in separate folders for each project). When you have everything together in one spot, it's easier to identify what fits the visual style and delete what doesn't. A great resource on online writing style is Microsoft’s Manual of Style for Technical Publications:

http://www.microsoft.com/mspress/books/6074.aspx

While it doesn’t cover instructional design, it would help standardize editorial style.

For the “living document” aspect, I’d suggest a wiki. Tiddlywiki is easiest to use and naturally supports tiny entries like you find in a style guide, but the last time I checked it can be edited by only one person.

A centralized library of assets could help, too. It could be as simple as storing all images in one spot on the intranet (rather than in separate folders for each project). When you have everything together in one spot, it’s easier to identify what fits the visual style and delete what doesn’t.

]]> By: Cathy Moore http://janetclarey.com/2007/11/04/what-components-go-into-a-style-guide/comment-page-1/#comment-4840 Cathy Moore Mon, 05 Nov 2007 14:06:00 +0000 http://janetclarey.com/?p=417#comment-4840 A great resource on online writing style is Microsoft's Manual of Style for Technical Publications: http://www.microsoft.com/mspress/books/6074.aspx While it doesn't cover instructional design, it would help standardize editorial style. For the "living document" aspect, I'd suggest a wiki. Tiddlywiki is easiest to use and naturally supports tiny entries like you find in a style guide, but the last time I checked it can be edited by only one person. A centralized library of assets could help, too. It could be as simple as storing all images in one spot on the intranet (rather than in separate folders for each project). When you have everything together in one spot, it's easier to identify what fits the visual style and delete what doesn't. A great resource on online writing style is Microsoft’s Manual of Style for Technical Publications:

http://www.microsoft.com/mspress/books/6074.aspx

While it doesn’t cover instructional design, it would help standardize editorial style.

For the “living document” aspect, I’d suggest a wiki. Tiddlywiki is easiest to use and naturally supports tiny entries like you find in a style guide, but the last time I checked it can be edited by only one person.

A centralized library of assets could help, too. It could be as simple as storing all images in one spot on the intranet (rather than in separate folders for each project). When you have everything together in one spot, it’s easier to identify what fits the visual style and delete what doesn’t.

]]> By: Tom Werner http://janetclarey.com/2007/11/04/what-components-go-into-a-style-guide/comment-page-1/#comment-2508 Tom Werner Mon, 05 Nov 2007 13:06:44 +0000 http://janetclarey.com/?p=417#comment-2508 Hi Janet, Two possibly-relevant web sites are listed in this VNU e-newsletter about culturally-generic writing for the web: http://www.trainingmagevents.com/learninggroup/search/article_display.jsp?vnu_content_id=1003224013 The web sites are: www.webpagecontent.com www.plainlanguage.gov Hi Janet,

Two possibly-relevant web sites are listed in this VNU e-newsletter about culturally-generic writing for the web:

http://www.trainingmagevents.com/learninggroup/search/article_display.jsp?vnu_content_id=1003224013

The web sites are:

http://www.webpagecontent.com

http://www.plainlanguage.gov

]]> By: Tom Werner http://janetclarey.com/2007/11/04/what-components-go-into-a-style-guide/comment-page-1/#comment-4839 Tom Werner Mon, 05 Nov 2007 13:06:00 +0000 http://janetclarey.com/?p=417#comment-4839 Hi Janet, Two possibly-relevant web sites are listed in this VNU e-newsletter about culturally-generic writing for the web: http://www.trainingmagevents.com/learninggroup/search/article_display.jsp?vnu_content_id=1003224013 The web sites are: www.webpagecontent.com www.plainlanguage.gov Hi Janet,

Two possibly-relevant web sites are listed in this VNU e-newsletter about culturally-generic writing for the web:

http://www.trainingmagevents.com/learninggroup/search/article_display.jsp?vnu_content_id=1003224013

The web sites are:

http://www.webpagecontent.com

http://www.plainlanguage.gov

]]> By: Christy Tucker http://janetclarey.com/2007/11/04/what-components-go-into-a-style-guide/comment-page-1/#comment-2507 Christy Tucker Mon, 05 Nov 2007 04:32:38 +0000 http://janetclarey.com/?p=417#comment-2507 The level of detail really depends on the specific needs for the situation. However, here's some things to think about including, specifically about instructional design standards and not just the spelling and grammar. Not all of these may apply, but he might use this as a starting point for the kinds of questions to ask. * Course structure guidelines (Units? Modules? Topics? How many? How are they divided?) * Templates to be used * Course length * When to use certain media * How to use images * Image styles (stock photos? clip art? combo?) * Color schemes (Are there requirements for certain clients or situations? Branding?) * Assessment guidelines (What types? When? How long?) * Course objectives (How many? How worded?) * Course descriptions (Sometimes there's guidelines for these) * Types of interaction & practice * Amount of interaction & practice * What goes in each set of documentation (instructor vs. participant guide, handouts) Sometimes the style expectations can be as specific as to the font, size, and style for each type of text. I've worked with one client who carefully reviewed the line spacing and number of blank lines (which was a bit over the top, but it's what they wanted). If there are visual style guidelines like that, documentation and samples can be really helpful. The level of detail really depends on the specific needs for the situation. However, here’s some things to think about including, specifically about instructional design standards and not just the spelling and grammar. Not all of these may apply, but he might use this as a starting point for the kinds of questions to ask.

* Course structure guidelines (Units? Modules? Topics? How many? How are they divided?)
* Templates to be used
* Course length
* When to use certain media
* How to use images
* Image styles (stock photos? clip art? combo?)
* Color schemes (Are there requirements for certain clients or situations? Branding?)
* Assessment guidelines (What types? When? How long?)
* Course objectives (How many? How worded?)
* Course descriptions (Sometimes there’s guidelines for these)
* Types of interaction & practice
* Amount of interaction & practice
* What goes in each set of documentation (instructor vs. participant guide, handouts)

Sometimes the style expectations can be as specific as to the font, size, and style for each type of text. I’ve worked with one client who carefully reviewed the line spacing and number of blank lines (which was a bit over the top, but it’s what they wanted). If there are visual style guidelines like that, documentation and samples can be really helpful.

]]>