Difference between revisions of "Help:Contents"

From TransitWiki
Jump to: navigation, search
(Category & page relationships)
(Relationships)
Line 3: Line 3:
 
The relationships between categories and pages provide some structure for content in the Wiki, which will be useful as the Wiki matures with more content, or becomes a repository for additional research projects. The typical relationship between categories or categories and pages is a parent-child relationship, although in some instances a page or category will have multiple parents.  A parent is a page or category with at least one child.  A child is a page or category that includes the <nowiki>[[Category:something]]</nowiki> tag.  Below is an explanation of the relationship between different levels of content.
 
The relationships between categories and pages provide some structure for content in the Wiki, which will be useful as the Wiki matures with more content, or becomes a repository for additional research projects. The typical relationship between categories or categories and pages is a parent-child relationship, although in some instances a page or category will have multiple parents.  A parent is a page or category with at least one child.  A child is a page or category that includes the <nowiki>[[Category:something]]</nowiki> tag.  Below is an explanation of the relationship between different levels of content.
 
# ''Group of categories'' (eg: Internal strategies, External strategies).  These are top-level groupings, and for this project these categories have no parents.  This level can be thought of as Parts of a report.
 
# ''Group of categories'' (eg: Internal strategies, External strategies).  These are top-level groupings, and for this project these categories have no parents.  This level can be thought of as Parts of a report.
# ''Category'' - items at this second level have a parent (a level 1 group of categories (eg: Operations planning)
+
# ''Category'' - items at this second level have a parent (a level 1 group of categories) and at least two "children" outcome (eg: Operations planning)
# Outcome or result within a category or group of categories (eg: Improve user experience)  An outcome or result can either be a page or category, depending
+
# ''Outcome or result'' is a category that describes a desired outcome for which a transit agency would employ strategies.  Content at this level has at least one parent and two children.  While content at this level will usually take the form of a category, it can take the form of a page if the content for none of the children strategies is (or is anticipated to be) long enough to warrant its own strategy page.
# Page - specific strategy linked to an outcome or result
+
# ''Strategy'' - a strategy usually takes the form of a page.  This page includes
 +
* an introduction to the concept covered in the page that gives the intelligent but unfamiliar reader context
 +
* an overview of the benefits and drawbacks involved with pursuing the strategy, including how the strategy can help an agency in pursuit of any desired parent ''outcome or result'' , but also any adverse effects the strategy may have on other strategies, aspects of transit service delivery, or stakeholders
 +
* examples of the strategy in action
 +
* further reading for those interested in learning more, including academic literature and case studies, with link to content or DOI/library page.  Each item linked in further reading should include at a minimum of two sentences that inform the reader's decision to follow or not follow the link.
 
# Sub-page - additional information linked to a specific strategy (page), but not an outcome
 
# Sub-page - additional information linked to a specific strategy (page), but not an outcome
  

Revision as of 18:54, 14 February 2012

About categories & pages

Relationships

The relationships between categories and pages provide some structure for content in the Wiki, which will be useful as the Wiki matures with more content, or becomes a repository for additional research projects. The typical relationship between categories or categories and pages is a parent-child relationship, although in some instances a page or category will have multiple parents. A parent is a page or category with at least one child. A child is a page or category that includes the [[Category:something]] tag. Below is an explanation of the relationship between different levels of content.

  1. Group of categories (eg: Internal strategies, External strategies). These are top-level groupings, and for this project these categories have no parents. This level can be thought of as Parts of a report.
  2. Category - items at this second level have a parent (a level 1 group of categories) and at least two "children" outcome (eg: Operations planning)
  3. Outcome or result is a category that describes a desired outcome for which a transit agency would employ strategies. Content at this level has at least one parent and two children. While content at this level will usually take the form of a category, it can take the form of a page if the content for none of the children strategies is (or is anticipated to be) long enough to warrant its own strategy page.
  4. Strategy - a strategy usually takes the form of a page. This page includes
  • an introduction to the concept covered in the page that gives the intelligent but unfamiliar reader context
  • an overview of the benefits and drawbacks involved with pursuing the strategy, including how the strategy can help an agency in pursuit of any desired parent outcome or result , but also any adverse effects the strategy may have on other strategies, aspects of transit service delivery, or stakeholders
  • examples of the strategy in action
  • further reading for those interested in learning more, including academic literature and case studies, with link to content or DOI/library page. Each item linked in further reading should include at a minimum of two sentences that inform the reader's decision to follow or not follow the link.
  1. Sub-page - additional information linked to a specific strategy (page), but not an outcome

Page titles

Please

  • use active voice
  • use simple language
  • avoid prepositions
  • avoid redundancy when possible (eg: transit, bus, rail)