RE: NEW ISSUE: 3989 [Guidelines] Suggested Format

Microsoft is pleased to contribute the following proposals:

1. A model section for the Guidelines document written using the Architecture of the WWW doc format,
2. A list of good practices for assertion authors and
3. A table that maps good practices for assertion authors to existing sections in the 'Web Services Policy 1.5 - Guidelines for Policy Assertion Authors' draft & shows what good practices need explanatory text.

in response to:
>a) Use a format similar to the Architecture of the WWW document
>b) Provide a list of good practice statements upfront (after the
>Table of Contents or in the Introduction).

Regards,

Asir S Vedamuthu
Microsoft Corporation


-----Original Message-----
From: public-ws-policy-request@w3.org [mailto:public-ws-policy-request@w3.org] On Behalf Of Asir Vedamuthu
Sent: Friday, November 17, 2006 5:56 PM
To: public-ws-policy@w3.org
Subject: NEW ISSUE: 3989 [Guidelines] Suggested Format


Title: Suggested format for the Guidelines document.

Description:

Guidelines and best practices in the Guidelines document [1] are hidden
in the prose. They are not easy to pull out.

Assertion authors would find it very useful if the Guidelines document
identifies a scenario, articulates the problem statement at the
assertion design level, enumerates the factors to be considered and
highlights good practices.

The Architecture of the WWW document [2] is a good model to follow.
Furthermore, providing the assertion authors with a list of good
practice statements upfront (for instance [3]) would be very useful.

Justification:

Guidelines and best practices are hidden in the prose. Assertion authors
need to read this document multiple times and dig for guidelines and
best practices. If the guidelines are clear and easy to find, the WG
(and other WGs such as I18N WG) will find it easy to review the
document, build consensus and adopt them.

Target: Guidelines for Assertion Authors.

Proposal:

We suggest using good practice statements as the center stage to
describe the guidelines for assertion authors. We request the WG to
consider the following possibilities:

a) Use a format similar to the Architecture of the WWW document
b) Provide a list of good practice statements upfront (after the Table
of Contents or in the Introduction).
c) Both a and b.

[1]
http://dev.w3.org/cvsweb/~checkout~/2006/ws/policy/ws-policy-guidelines.
html?rev=1.8&content-type=text/html;%20charset=utf-8
[2] http://www.w3.org/TR/webarch/
[3] http://www.w3.org/TR/webarch/#p10

Regards,

Asir S Vedamuthu
Microsoft Corporation