Best Practices for Examples Pages

(Difference between revisions)

Jump to: navigation, search
m (When Adding Examples)
Current revision (22:44, 1 November 2013) (view source)
(Details of Example Scoping: try improving heading to "What kind of examples and why")
 
(26 intermediate revisions not shown.)
Line 1: Line 1:
-
= Best Practices for Example Pages =
+
<entry-title>Best Practices for Examples Pages</entry-title>
-
'''Example''' pages are the first stage of the exploration [[process]] which must precede proposing a new microformat. Current [[Main Page#Exploratory Discussions|explorations]] are listed on the [[Main Page]].  You can use the [[examples-template]] to help you create your own page.
+
'''*-examples''' pages are the first stage of the exploration [[process]] which must precede proposing a new microformat. Current [[Main Page#Exploratory Discussions|explorations]] are listed on the [[Main Page]].  You can use the [[examples-template]] to help you create your own page.
-
== Purpose of Example Pages ==
+
== Current Human Behavior on the Web ==
-
(adapted from [[process]])
+
Examples for the development of a microformat {{must}} reflect:
 +
* [[#Current|Current]]
 +
* [[#Human|Human]]
 +
* [[#Behavior|Behavior]]
 +
* on the [[#Web|Web]]
 +
See each of those sections in the reference at the end for what we mean by those and why.
-
Document current human behavior. Remember, we're [http://ifindkarma.typepad.com/relax/2004/12/microformats.html paving the cowpaths]- before you do that you have to ''find'' the cowpaths. Your documentation should be a collection of real world sites and pages which are publishing the kind of data you wish to structure with a microformat.  From those pages and sites, you should extract markup examples and the schemas implied therein, and provide analysis.
+
== Template of recommended sections ==
 +
A good *-examples page has the <span id="Recommended_sections">following sections</span>, you can think of this like a template:
-
== Recommended sections ==
+
Top level (&lt;entry-title>):
-
+
-
Top level (=):
+
* Introductory sentence
* Introductory sentence
-
Second level (==):
+
The following items can be used as second level headings == ... ==  
-
* The Problem)
+
* purpose
** ''What is the purpose of this exploration?''
** ''What is the purpose of this exploration?''
-
* Participants
+
** ''What real world problem(s) / user-scenarios are being solved?''
-
** ''Bulleted list of who is active (or cares)''
+
* real world examples
-
* Real-World Examples
+
** ''Links to public web pages, either popular or insightful''
** ''Links to public web pages, either popular or insightful''
-
* Existing Practices
+
* analysis of publishing practices
-
** ''Summary of common patterns discovered''
+
** ''Summary and analysis of common patterns discovered from above examples''
-
** ''Other attempts to solve The Problem''
+
** ''Other attempts to solve The Problem'' (other actual [[formats]] belong in the *-formats page)
-
* See Also / Next Steps
+
* see also
** ''Link to related pages as they become available''
** ''Link to related pages as they become available''
-
*** *-formats
+
* next steps
-
*** *-brainstorming
+
** *-formats
 +
** *-brainstorming
 +
 
 +
Details on specific sections:
 +
 
 +
=== real world examples section ===
 +
* '''Flat list at a minimum.''' The real world examples section should be at a minimum a flat list of examples.  See further down for what a good example has.
 +
* '''Grouping into categories can help.''' A giant flat list of examples can sometimes be difficult to navigate and analyze as a whole. Consider grouping related examples into a flat list of categories.  If you're not sure how to categorize the examples, or if there are multiple axes across which you could categorize the examples, ask on the [[IRC]] channel or [http://microformats.org/discuss mailing list].
== Good Examples of Examples ==
== Good Examples of Examples ==
The following pages are some of the best examples of instantiating this design pattern:
The following pages are some of the best examples of instantiating this design pattern:
-
* [[reviews-formats]]
+
* [[review-examples]]
-
* [[blog-post-formats]]
+
* [[media-info-examples]]
-
* [[blog-description-format]]
+
* [[blog-post-examples]]
 +
 
 +
== A Good Example Has ==
 +
 
 +
A good example has several things:
 +
* URL to the actual example on the Web
 +
* Link text of that hyperlink should look like a citation of that example, e.g. who, what site
 +
* Perhaps an illustrative snippet of code (markup) from the example
 +
* Analysis of the implied schema represented by that snippet, with at a minimum a flat list of the "fields" present in the example snippet.
== When Adding Examples ==
== When Adding Examples ==
Line 37: Line 55:
When adding examples to an existing *-examples page, please try to add the examples into the existing organizational structure in the page.  E.g. if the examples are grouped or categorized in a certain way, try to add new examples into those existing categories, instead of a new section.   
When adding examples to an existing *-examples page, please try to add the examples into the existing organizational structure in the page.  E.g. if the examples are grouped or categorized in a certain way, try to add new examples into those existing categories, instead of a new section.   
-
If you have to add a new category or subsection, do so, but try to do so in harmony with existing categories.  If it is not obvious how to do so, or if the categories don't seem to make sense, then it might be a good time to ask a question on the [http://microforamts.org/discuss mailing list or irc channel].
+
If you have to add a new category or subsection, do so, but try to do so in harmony with existing categories.  If it is not obvious how to do so, or if the categories don't seem to make sense, then it might be a good time to ask a question on the [[IRC]] channel or [http://microformats.org/discuss mailing list].
 +
 
 +
== Purpose of Example Pages ==
 +
(adapted from [[process]])
 +
 
 +
Document current human behavior on the Web. Remember, we're [http://ifindkarma.typepad.com/relax/2004/12/microformats.html paving the cowpaths]- before you do that you have to ''find'' the cowpaths. Your documentation should be a collection of real world sites and pages which are publishing the kind of data you wish to structure with a microformat.  From those pages and sites, you should extract markup examples and the schemas implied therein, and provide analysis.
 +
 
 +
== What kind of examples and why ==
 +
By current human behavior on the web, we mean:
 +
 
 +
=== Current ===
 +
* This is what people are doing '''now''' on the Web. 
 +
* This is not:
 +
** what people did 50 years ago
 +
** what you expect people to do in the future
 +
 
 +
=== Human ===
 +
Explicit user entered and published information.  While automatically published information such as logs from an eletronic thermometer can be interesting, they are not human produced (unless said thermometer is stuck in a human, and that's only indirect/implicit/uncontrolled) and thus do not reflect what humans themselves explicitly do.
 +
 
 +
=== Behavior ===
 +
* What people actually '''do'''. Think empirical evidence, much as in the same way that the scientific method requires gathering of empirical data.
 +
* not:
 +
** what they ''might'' do
 +
** ''should have'' done
 +
** ''would'' do
 +
** Intention/Desire/Want. A common mistake done by folks researching background for formats is to explicitly *ask* folks what they *want* or *prefer*, as opposed to *studying* what they *do*.  It is well known among behavioral researchers/surveyors that *asking* people what they *want*, or even *asking* people what they *do*, will give you very different (and worse / less accurate) answers than actually *studying* what they *do* in the real world.
 +
** Formats. Formats are prescriptions for behavior, not behavior itself.  For documenting formats, create a *-formats page.
 +
 
 +
=== Web ===
 +
* The examples MUST focus on examples actually published on the Web, at a publicly available URL, which should be documented along with the example itself on the wiki page.
 +
* Non-web examples are ok *only* for secondary/tertiary consideration, and by no means outweight (no matter what their quantity etc.) the Web examples.
 +
** private files
 +
** paper
 +
** etc.
 +
 
 +
== See also ==
 +
* [[examples-examples]]

Current revision


*-examples pages are the first stage of the exploration process which must precede proposing a new microformat. Current explorations are listed on the Main Page. You can use the examples-template to help you create your own page.

Contents

Current Human Behavior on the Web

Examples for the development of a microformat MUST reflect:

See each of those sections in the reference at the end for what we mean by those and why.

Template of recommended sections

A good *-examples page has the following sections, you can think of this like a template:

Top level (<entry-title>):

The following items can be used as second level headings == ... ==

Details on specific sections:

real world examples section

Good Examples of Examples

The following pages are some of the best examples of instantiating this design pattern:

A Good Example Has

A good example has several things:

When Adding Examples

When adding examples to an existing *-examples page, please try to add the examples into the existing organizational structure in the page. E.g. if the examples are grouped or categorized in a certain way, try to add new examples into those existing categories, instead of a new section.

If you have to add a new category or subsection, do so, but try to do so in harmony with existing categories. If it is not obvious how to do so, or if the categories don't seem to make sense, then it might be a good time to ask a question on the IRC channel or mailing list.

Purpose of Example Pages

(adapted from process)

Document current human behavior on the Web. Remember, we're paving the cowpaths- before you do that you have to find the cowpaths. Your documentation should be a collection of real world sites and pages which are publishing the kind of data you wish to structure with a microformat. From those pages and sites, you should extract markup examples and the schemas implied therein, and provide analysis.

What kind of examples and why

By current human behavior on the web, we mean:

Current

Human

Explicit user entered and published information. While automatically published information such as logs from an eletronic thermometer can be interesting, they are not human produced (unless said thermometer is stuck in a human, and that's only indirect/implicit/uncontrolled) and thus do not reflect what humans themselves explicitly do.

Behavior

Web

See also

Best Practices for Examples Pages was last modified: Friday, November 1st, 2013

Views