Help:Project article

From The Collaboratory

Jump to: navigation, search

Contents

Project Article

A project article gives information about or relevant to a project. There are two types of project articles; main and internal. The main project article is for all information relevant to outsiders wishing to get a sense of what the project is about and what the project is doing. The internal project article is meant for internal documentation not suited for the main project article. It is also meant to serve as the root article for all articles related to the project in the group's namespace. Adhering to the following conventions along with the article naming and style guidelines will help users to find internal project articles while also providing a standard look and feel to the main group articles.

Main project article

The main project article is designed to be a starting point for both team members and nonmembers. This main article should describe the project and list the members, purpose, and goals of the project. The main project article is NOT to be used as a workspace for the team. Those belong in the project's internal article.

Naming

The main project article should be in the main namespace, not the group's namespace. This is done so users can enter the project's name into the searchbar (which only searches the main namespace) and be automatically directed to the project's main article, rather than a list of possible matches. To accomplish this, the name of your main project article should simply be (using Water Access as an example) "Percusion Well Drilling Project". (Note that project names are considered proper names, and should therefore be capitalized.)

Thereafter, all articles belonging to this project with the exception of this main article should be named such that the articles name is prefixed by both the group's namespace and the project. For example, "WA:Percussion Well Drilling Project/How to drill a well".

Template

In order to preserve continuity across the entire wiki, all main project articles should have the same basic structure. The main project article adheres to the project template.

  • Things to include under the "Resources" heading
    • Link to your Annual Plan
    • Link to your Internal Project Article

Internal project article

The internal project article is meant to be both a root article and a resource for ongoing project documentation. It does not adhere to a template, and can be useful for a number of project related things.

Naming

The internal project article should be in the group's namespace, not the main namespace. The idea of the internal project article being the root article of the project in the group's namespace is based on the naming of this article, such that all other articles related to a project in the group's namespace branch off of it. To accomplish this, the name of your internal project article should be (Again, using Water Access) "WA:Percussion Well Drilling Project". All articles belonging to this project should be named such that the articles name is prefixed by both the group's namespace and the project. For example, "WA:Percussion Well Drilling Project/How to drill a well".

Personal tools
Navigation