OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

 


 

   Quick-guides

[ Lists Home | Date Index | Thread Index ]

In addition to the general purpose Editorial Guidelines, and with regards to Bruce's "admin info" reference below, I think each wiki
page should be supported by a quick-guide--a separate page with *brief* instructions for contributing content. This could be linked
from the upper right corner (or some other consistent position) of the wiki page. We may even want to develop some easily
identifiable icon for it. 

The quick-guide could give specifics on how to add content to that particular page, e.g., the required data fields, word count,
definition of what content is appropriate, etc.) These instructions will vary by page, for example, Events listings need to include
city, country, date, type of event, etc. where product listings need to include product name, supplier, etc. and white paper
listings need to include title, authors, etc.

I think having quick-guides specific to each page will make it easier for contributors to supply the necessary information. Links to
the full Editorial Guidelines can be included on all quick-guide pages.


I created a sample "Contributing Content" quick-guide for the Events page at http://dita.xml.org/events-content-guideline.

Please review and let me know what you think. 

Thanks,
Carol

________________________________

From: Esrig, Bruce (Bruce) [mailto:esrig@lucent.com] 
Sent: Wednesday, December 07, 2005 6:20 PM
To: dita-fa-edboard@lists.xml.org
Cc: 'Jennifer Linton'
Subject: RE: [dita-fa-edboard] dita.xml.org


For the list, here's what Jen and I came up with.
 
Bruce
 
===========
 
topic-setter: brief introduction about what this subject is about

 

links to intro info: either (a) another paragraph with links to info about best practices that might already be out there, or (b) a
link to a topic on the wiki that contains links possibly with glosses

 

links to admin info: how to post and what format to use in a page for this subject

 

top-level sub-topics: probably an intro sentence and then a bunch of bullet items, each with a link to a contributed topic.

	-----Original Message-----
	From: Jennifer Linton [mailto:jennifer.linton@comtech-serv.com]
	Sent: Wednesday, December 07, 2005 5:55 PM
	To: dita-fa-edboard@lists.xml.org
	Subject: [dita-fa-edboard] dita.xml.org
	
	

	I was sitting down to try and write up some information for the Best Practices and Other Resources areas in the community
wiki. I am a little confused about what we need to put there. Eric wrote quite a bit so far for the Specializations section. Do we
need to write this much for each of the sections. I could go into depth for the Best Practices, but I'm not sure.

	 

	Can someone give me some direction about what exactly we need to have on these intro pages.

	What I am thinking is that we need 

	1) A brief description of what we intend people to post in these areas

	2) How to post for these areas

	3) What kind of format these posts should be in for each of the sections since they will all be different.

	 

	Thanks,

	Jen

	 

	 

	Jen Linton

	Comtech Services, Inc.

	Senior Consultant and Web Manager

	710 Kipling St. Suite 400

	Denver, CO 80215

	P: 303-232-7586

	F: 303-232-0659

	 







 

News | XML in Industry | Calendar | XML Registry
Marketplace | Resources | MyXML.org | Sponsors | Privacy Statement

Copyright 2001 XML.org. This site is hosted by OASIS