Locations/Guidelines: Difference between revisions
(init) |
(→New Location Pages Guidelines: added another link example of good location format) |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
= New Location Pages Guidelines = | = New Location Pages Guidelines = | ||
This document outlines the guidelines that are used in the construction and maintenance of the new Location pages on the wiki. The goal of these guidelines is to | This document outlines the guidelines that are used in the construction and maintenance of the new Location pages on the wiki. The goal of these guidelines is to merge the old tab based system while preserving as much content as viable and creating more maintainable pages. Check out [[genetics]] or [[arrivals]] for a good example of a merged and rewritten page. | ||
== What do we do with the old images and how do we use them on the new pages? == | == What do we do with the old images and how do we use them on the new pages? == | ||
''Shouldn’t we place images we have next to the relevant room text?'' '''No.''' If we do that, we create a tight coupling between the text and images. '''<u>The focus is on the text.</u>''' The images should ''feel'' optional. If we have an outdated or several outdated images next to the text the uninformed reader might think that the text is also outdated. If on the other hand, there are texts that don’t have an image the reader might assume that they are also outdated or not important if other rooms have several images. Images are also much harder to maintain. | ''Shouldn’t we place images we have next to the relevant room text?'' '''No.''' If we do that, we create a tight coupling between the text and images. '''<u>The focus is on the text.</u>''' The images should ''feel'' optional. If we have an outdated or several outdated images next to the text the uninformed reader might think that the text is also outdated. If on the other hand, there are texts that don’t have an image the reader might assume that they are also outdated or not important if other rooms have several images. Images are also much harder to maintain. All images should be placed in a gallery section. Images of entire departments are to be avoided. Instead, the Maps pages be linked to, to give the reader a zoomed-out perspective. | ||
All images should be placed in | |||
== Good Room text, Domain, and Separation of Concerns == | == Good Room text, Domain, and Separation of Concerns == | ||
The text should be a general description of the room in that department that applies to all stations. Because the text is supposed to apply to all stations the WHERE of a location is NOT written like: “left of x” or “below of y”. | The text should be a general description of the room in that department that applies to all stations. Because the text is supposed to apply to all stations the WHERE of a location is NOT written like: “left of x” or “below of y”. You don’t need to say, for example, “Genetics is in the medical department”. We are on the medical department section. It is implied. | ||
Room text should contain the following content: | Room text should contain the following content: | ||
* Describe any consistent visual features across all stations of the room (floor tile color, wall color, signs…) | |||
* Describe any consistent visual features of the room (floor tile color, wall color, signs…) | |||
* State who works there with a link to the jobs page. | * State who works there with a link to the jobs page. | ||
* State the <u>major</u> room features and most important machine if applicable. Optionally link to the appropriate machine. | * State the <u>major</u> room features and most important machine if applicable. Optionally link to the appropriate machine. | ||
| Line 26: | Line 13: | ||
* Add any station specific differences. | * Add any station specific differences. | ||
* Add any miscellaneous notes. | * Add any miscellaneous notes. | ||
The room pages should '''NOT''' explain how things work and should '''NOT''' go <u>into detail</u> on what things are used for. | The room pages should '''NOT''' explain how things work and should '''NOT''' go <u>into detail</u> on what things are used for. | ||
Latest revision as of 10:06, 8 April 2024
New Location Pages Guidelines
This document outlines the guidelines that are used in the construction and maintenance of the new Location pages on the wiki. The goal of these guidelines is to merge the old tab based system while preserving as much content as viable and creating more maintainable pages. Check out genetics or arrivals for a good example of a merged and rewritten page.
What do we do with the old images and how do we use them on the new pages?
Shouldn’t we place images we have next to the relevant room text? No. If we do that, we create a tight coupling between the text and images. The focus is on the text. The images should feel optional. If we have an outdated or several outdated images next to the text the uninformed reader might think that the text is also outdated. If on the other hand, there are texts that don’t have an image the reader might assume that they are also outdated or not important if other rooms have several images. Images are also much harder to maintain. All images should be placed in a gallery section. Images of entire departments are to be avoided. Instead, the Maps pages be linked to, to give the reader a zoomed-out perspective.
Good Room text, Domain, and Separation of Concerns
The text should be a general description of the room in that department that applies to all stations. Because the text is supposed to apply to all stations the WHERE of a location is NOT written like: “left of x” or “below of y”. You don’t need to say, for example, “Genetics is in the medical department”. We are on the medical department section. It is implied.
Room text should contain the following content:
- Describe any consistent visual features across all stations of the room (floor tile color, wall color, signs…)
- State who works there with a link to the jobs page.
- State the major room features and most important machine if applicable. Optionally link to the appropriate machine.
- Describe the primary function of the room in general. Link to the department/job guide if applicable.
- Add any station specific differences.
- Add any miscellaneous notes.
The room pages should NOT explain how things work and should NOT go into detail on what things are used for.