RE: Vocabularies for Technical Publishing

Hi Dan,

The changes have been added and the examples have been updated.  'currentProduct' and 'aboutProduct' have been removed and examples now show using 'about'.   

Links to updated proposals:
http://www.w3.org/wiki/File:Schema.org_TechArticle_v2.6.pdf

http://www.w3.org/wiki/File:Schema.org_APIReference_v2.6.pdf



The only open item is to extend 'Products' with 'currentModel' and show an example of using URL as external reference. The URL reference mitigates "stale data" issues by allowing the current product version value to be easily maintained in one location.

Product example addendum>>  
 
Content may pertain to multiple versions of a product.  

Here the currentModel is shown as an external reference:

         <div itemprop="about" itemscope itemtype="http://schema.org/Product">
         <p>
          <strong>Applies to:</strong>
          <span itemprop="name">Widget 2008</span>
          <span itemprop="name">Widget 2005</span>
         </p>
          <meta itemprop="model" content="2008"/>
          <meta itemprop="model" content="2005"/>
          <link itemprop="currentModel" href="http://absolutepath/widgetpage/Current_version.html"/>
        </div>

Here the currentModel is shown as a value:

         <div itemprop="about" itemscope itemtype="http://schema.org/Product">
         <p>
          <strong>Applies to:</strong>
          <span itemprop="name">Widget 2008</span>
          <span itemprop="name">Widget 2005</span>
         </p>
          <meta itemprop="model" content="2008"/>
          <meta itemprop="model" content="2005"/>
   <meta itemprop="currentModel" content="2012"/>
 </div>

<<


Thanks
-Kenley


-----Original Message-----
From: Dan Brickley [mailto:danbri@danbri.org] 
Sent: Thursday, July 12, 2012 5:45 AM
To: Kenley Lamaute
Cc: public-vocabs@w3.org
Subject: Re: Vocabularies for Technical Publishing

Hi Kenley,

Where are with this, from your perspective?

I like the idea of using 'about', primarily because the 'current' in 'currentProduct' leaves me worrying about stale data. Many sites begin their life database-backed but then end up 'pickled'/'frozen' for various reasons (e.g. they're PHP generated and then security holes lead to the dynamic generation being replaced with a one-time snapshot).

Can you suggest a final issue list for getting these changes added?

Many thanks,

Dan

On 16 June 2012 08:03, Kenley Lamaute <kenleyl@microsoft.com> wrote:

> ·         aboutProduct and currentProduct warrants further discussion. You
> bring up a good point on simplifying the description, and we may be 
> able to simplify the proposal even more by simply using ‘about’ to 
> refer to the ‘Product’ item.
>
> The scenario for aboutProduct and currentProduct:
>
> It is very common for steps in technical documentation to vary between 
> product versions, and multiple supported versions of a product often 
> exists in a marketplace concurrently.
> As a product matures the content for that product version accumulates 
> links / popularity. This becomes a problem when a new product releases 
> to the marketplace and customers search for information on 
> implementing the new product.  Often times newer content is often 
> difficult to find because it must compete with legacy content which 
> overwhelmingly appears first in search results.
>
> The purpose of aboutProduct and currentProduct is to help search 
> engines disambiguate between product versions, and offer newer content 
> for the product when appropriate.
>
>
>
> With this in mind, instead of using aboutProduct and currentProduct , 
> a more elegant solution may be to refer to the ‘Product’ item using the ‘about’
> property that we inherit from CreativeWork.
>
>
>
> Example:
>
>
>
> Here 'about' describes the Product and version pertaining to the 
> content; as well as, version of the most recent shipping product:
>
>
>
> <div itemprop="about" itemscope itemtype="http://schema.org/Product">
>
>       <p>
>
>         <strong>Applies to:</strong>
>
>         <span itemprop="name">Microsoft SQL Server 2008 R2</span>
>
>       </p>
>
>       <meta itemprop="model" content="2008 R2"/>
>
>       <meta itemprop="currentModel" content="2012"/>
>
> </div>
>
>
>
> Here 'about' also informs where to get more information on the overall
> concept:
>
>
>
> <span itemprop="about" itemscope 
> itemtype="http://schema.org/CreativeWork">
>
>       <meta itemprop="name" content="Database management System"/>
>
>       <meta itemprop="url" 
> content="http://en.wikipedia.org/wiki/Dbms"/>
>
> </span>
>
>
>
> Interested in the communities thoughts on this. I’ll kick-off a 
> separate thread to get input from the community on adding 
> “currentModel” property to Product.
>
>
>
> ·         Re: External enumeration: I concur, that using the method
> described in the External Enumeration proposal could work as well. I 
> expect that search engines would support both.
>
>
>
> All the best,
>
> Kenley
>
>

Received on Friday, 13 July 2012 09:49:19 UTC