Click to enlarge Making Submissions to the e-Framework
This page explains our quality process for adding to the e-Framework’s growing knowledge base.
The diagram shows the basic submission process for contributing your descriptive documentation about technical components. The steps involve a series of interactions between a potential submitter, the community, the e-Framework technical editor and our moderators, the e-Framework Integrity Group (eFIG). The eFIG is the panel that handles contributions to the e-Framework.
Basic steps
- Collaborative development and documentation of the technical component
- Submission of the descriptive documents
- Review by the e-Framework Integrity Group (eFIG)
- Publication of accepted submissions on the website
Details are described in the submission process for each technical component:
Development and documentation
Community wiki discussion page
Potential submitters are encouraged to use the collaborative tools provided by the e-Framework Community Wiki to develop their initial documentation so they can obtain feedback from their colleagues and the community.
Documentation templates and instructions
-
Downloadable Word documentation templates
The e-Framework has a prescribed format for describing the technical components. This format is outlined in the documentation templates that are available for download from the table below. Authors use the templates to develop the description of their component, and should attach copies of their drafts to their wiki discussion page.
-
Instructions for using the templates
Guidelines and tips for successfully completing the templates are provided for each component type.
-
Wiki page template option
As an alternative to the Word templates, authors can develop their initial documentation as a wiki page. A blank template for a wiki page can be copied from these pages on the wiki for each technical component, respectively:
-
Assistance with using the templates
Contact the technical editor: editor@e-framework.org
Submission
-
Online submissions
Submitters can transmit their completed documentation to the e-Framework via this website.
- Fill in the required fields of the online submission form
- Attach the completed template document
- If diagrams and other files are being submitted, they should be combined with the completed template into a single, zipped file and attached
- Click "Submit"
- An email message is sent to the submitter to confirm receipt of the submission
Note: If documentation has been developed using a wiki page, copy the content into a blank Word document and use it to make the submission.
-
Email submissions
As an alternative, submitters can simply send an email message to the technical editor and attach their documents (template, diagrams, etc.). The email message must include the following information:
- Submitter’s first and last name
- Email address for correspondence
- Telephone number
- Organisational affiliation
- Associated project name
- URL of the discussion page on the Community Wiki
- Policy Acceptance Statement: On behalf of all contributors, I agree that we have read and agree to all e-Framework submission policies including the e-Framework IP Policy.
Email the message and attachments to: editor@e-framework.org
Review and QA process
The e-Framework aims to publish well-documented and technically sound components in the registries that it maintains on the e-Framework website. All submitted technical component documentation will be reviewed for completeness by the editorial team. The e-Framework Integrity Group will evaluate the submissions according to the published Quality Assurance (QA) Processes and Quality Assurance Criteria for each technical component.
Publication on the website
Accepted submission will be published in the technical component registries on the e-Framework website. Policies that govern submission, acceptance and publication are detailed in the submission process for each of the technical components.
Last updated 14 October 2008