W3C home > Mailing lists > Public > public-swbp-wg@w3.org > May 2006

comment: BP Recipes for Publishing RDF Vocabularies - Introduction

From: Karl Dubost <karl@w3.org>
Date: Fri, 12 May 2006 16:31:03 +0900
Message-Id: <FED5E5D0-6D6A-4081-B8D5-E9BE919787B1@w3.org>
To: public-swbp-wg@w3.org

Hi,
This is a QA Review comment for "Best Practice Recipes for Publishing
RDF Vocabularies"
http://www.w3.org/TR/2006/WD-swbp-vocab-pub-20060314/
Tue, 14 Mar 2006 12:48:26 GMT
1st WD

[[[
Introduction

This document is intended for the creators and maintainers of RDFS  
and OWL vocabularies or ontologies. (In this document, vocabulary and  
ontology are used interchangeably.) It provides step-by-step  
instructions for publishing vocabularies on the Web, giving example  
configurations designed to cover the most common cases. For more  
information about RDFS and OWL see [RDFS, RDFPrimer, OWLGuide,  
OWLFeatures].
]]]

-- Best Practice Recipes for Publishing RDF Vocabularies
http://www.w3.org/TR/2006/WD-swbp-vocab-pub-20060314/#secintro
Tue, 14 Mar 2006 12:48:26 GMT

I'm not sure if sentences with parantheses in isolation are correct  
in English. I may be wrong. What about

	"This document is intended for the creators and maintainers
	of vocabularies in RDFS and OWL (Vocabulary and ontology are
	used interchangeably in the context of this specification)."



[[[
This document is presented as a 'cookbook' of 'recipes'. Each recipe  
takes the reader through the steps needed to publish a vocabulary on  
a Web server and to configure the Web server to support Semantic Web  
applications. The section choosing a recipe provides guidance on  
which recipe is most appropriate for your situation and requirements.  
Once you have chosen a recipe, follow the steps given, adapting the  
examples for your particular vocabulary.
]]]

-- Best Practice Recipes for Publishing RDF Vocabularies
http://www.w3.org/TR/2006/WD-swbp-vocab-pub-20060314/#secintro
Tue, 14 Mar 2006 12:48:26 GMT

Avoid too much repetition (This document…)
Use appropriate English quotes  “”
Do not change the style from neutral (reader) to direct (you).


	This “cookbook” gives “recipes” describing the steps needed 	
		1. to publish a vocabulary on a Web server,
		2. configure the Web server to support Semantic Web
                    applications.
	The section “Choosing a recipe” provides guidance for choosing
	the most appropriate recipes depending on the situation and the
	requirements. Once the recipe has been chosen, the reader can
	follow the steps, adapting the examples for a particular
	vocabulary.



Two good references for writing (I know how much it's difficult to  
see the mistakes we do when we are working on something, I do all the  
times.)
   * Manual of Style
     http://www.w3.org/2001/06/manual/
   * The Elements of Style
     http://www.bartleby.com/141/




-- 
Karl Dubost - http://www.w3.org/People/karl/
W3C Conformance Manager, QA Activity Lead
   QA Weblog - http://www.w3.org/QA/
      *** Be Strict To Be Cool ***
Received on Friday, 12 May 2006 07:31:14 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Tuesday, 8 January 2008 14:17:21 GMT