SV: [plcs] Help files

[<mats.nilsson@fmv.se>]

Sounds like an excellent idea Rob!

(I hope to find time soon to assist you with this work)

 

Regards,
  Mats
..............................................................................
Mats Nilsson – KC Logistik
FMV - Försvarets materielverk
Swedish Defense Materiel Administration
S-115 88 Stockholm, Sweden
tel: +46 8 782 47 24     mobile: +46 70 267 47 24
fax: +46 8 782 65 64     e-mail: mats.nilsson@fmv.se

---

Frĺn: Rob Bodington [mailto:rob.bodington@eurostep.com]
Skickat: den 9 juni 2005 08:43
Till: plcs@lists.oasis-open.org
Ämne: [plcs] Help files

I have just had a look at the DEX help files whilst updating a help file to describe the use of  /IGNORE etc.

 

I think that we need to restructure the help files into different sections to reflect the different types of reader.

 

I think that there are three types of reader that the help should address:

 

1)       Business users
People who have are interested if the DEXs can address their business requirements

2)       Implementers
People who want to develop DEX translators / systems

3)       DEX developer
People who are developing DEXs

 

I think that the help files are currently targeted at the third type of user.

 

I think that we should restructure  the Help contents to reflect the above.

(dexlib/help/dex/index.xml)

 

How about:

 

Introduction

                DEX Library frequently asked questions (FAQ)

            Introduction to DEXs, Capabilities, Business Concepts and Reference Data.

       PLCS contact information

Getting started

Site navigation instructions

Guide on how to set up your computor for access to DEXlib and STEPmod on Sourceforge.net.

DEX developers (to be removed)(cvs_dvlp.htm)

DEX users (to be removed)(cvs_non_dvlp.htm)

Guide on how to download, work with, and upload DEXlib and STEPmod on Sourceforge.net.

The DEXlib directory structure

 

Information for Business users

                ???? (not sure what should go here)

 

Information for Implementer’s

                Introduction

                Use of reference data

                Modelling constructs

 

Information for DEXLib developers (most of the exiting content)

       Data Exchange Sets (DEXs)

       Developer Guide (derived from the DEX Cookbook)

       Review and Test Guide

       Additional developer info

       Building HTML using ANT

       DEX long forms information

       Reference Data

       Developer Guide

       OWL Introduction

       Process for RD Creation

       Use of annotation properties

       Raising issues against RD

       Reference Data development with the Protégé tool

       Protégé installation

       Protégé usage

 

Regards
Rob

-------------------------------------------   
Rob Bodington
Eurostep Limited
Web Page: http://www.eurostep.com http://www.share-a-space.com
Email: Rob.Bodington@eurostep.com
Phone: +44 (0)1454 270030
Mobile: +44 (0)7796 176 401