[news.eclipse.technology.epf] EPF Content Authoring Artifacts

[Jim Ruehlin <jruehlin@xxxxxxxxxx>]

Hello,

At the last Committers Meeting we discussed content authoring guidelines 
and future "sample" plug-ins. The purpose of these are to provide 
guidance for new content developers and give committers some support in 
assessing the quality of content submissions. I've attached a diagram 
that shows potential documents and plug-ins that would address these 
concerns.

I've also attached drafts of two documents mentioned in the diagram. 
They provide guidance for content authoring. We've used these internally 
at IBM and are posting them for review, comments, and to give people who 
are starting to build plug-ins some help. We'd like to get some response 
and ultimately post final approved versions to the EPF website. They are:

Plug-in Development Guide for EPF Composer - describes how to organize 
and write content that is extensible, understandable, and consistent 
with other plug-ins. This information should be understood by anyone 
creating method content with the EPF Composer.
Text Style Guide for EPF Composer - describes conventions and tips in 
writing text (particularly in HTML) in the EPF Composer. This 
information should be understood by anyone creating or finalizing (copy 
editing) method content using the Composer.

The other artifacts described in the diagram are plug-ins. Ideally, the 
information in the documents could be moved into a guideline-only 
plug-in that serves as an example as well as guidance. An authoring 
method plug-in and example (both based on BUP) could then be created 
that follow the approved authoring guidelines.

Comments on all three attachments are encouraged.

Thanks,
Jim Ruehlin
jruehlin@xxxxxxxxxx

Attachment: Plug-in Development Guide for EPF Composer.doc
Description: MS-Word document

Attachment: Text Style Guide for EPF Composer.doc
Description: MS-Word document