GOD manual
(Update the page to follow the directive not to use sub-pages!) |
|||
| (19 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
== | == About this manual == | ||
<blockquote> | <blockquote> | ||
| Line 7: | Line 7: | ||
'''The ''GOD manual'' tells GOD crew how to do things.''' It's the repository of knowledge that describes the majority of processes that are followed at (and occasionally between) events. | '''The ''GOD manual'' tells GOD crew how to do things.''' It's the repository of knowledge that describes the majority of processes that are followed at (and occasionally between) events. | ||
{{Caution|'''This wiki is publicly accessible.''' The vast majority of things that GOD do are fine to publish here, but be careful not to reference details of plot that aren't generally available. You can talk about the existence of (say) [https://www.profounddecisions.co.uk/empire-wiki/Children_in_bloom#Chaos_Fruit chaos fruit], since that's available on the player wiki, and you can talk about how we organise them and print them, but don't give any details about how they work from a plot or game mechanic perspective. Equally, if you want to provide screenshots or similar, make sure you don't use a real player account; use Crew Room (PID 0) or Ref Dummy Character (CID 0.1).}} | {{Caution|'''This wiki is publicly accessible.''' The vast majority of things that GOD do are fine to publish here, but be careful not to reference details of plot that aren't generally available. You can talk about the existence of (say) [https://www.profounddecisions.co.uk/empire-wiki/Children_in_bloom#Chaos_Fruit chaos fruit], since that's available on the player wiki, and you can talk about how we organise them and print them, but don't give any details about how they work from a plot or game mechanic perspective. Equally, if you want to provide screenshots or similar, make sure you don't use a real player account; use Crew Room (PID 0) or Ref Dummy Character (CID 0.1).}} | ||
== | == Introduction == | ||
* [[Welcome to GOD]] | * [[Welcome to GOD]] | ||
== Background == | |||
* Relevant information from the crew wiki: | |||
** [[Crew organisation]] | |||
** [[Radio protocol]] | |||
* Empire resources | |||
** [[Currency]] | |||
** [[Materials]] | |||
** [[Cards & Lammies]] | |||
** [[Bourse Resources]] | |||
== Event specials == | |||
* Future | |||
** [[GOD 2024 E4 specials]] | |||
* Past | |||
** [[GOD 2024 E3 specials]] | |||
** [[GOD 2024 E2 specials]] | |||
** [[GOD 2024 E1 specials]] | |||
** [[GOD 2023 E4 specials]] | |||
** [[GOD 2023 E3 specials]] | |||
== Physical processes == | |||
* [[GOD physical organisation]] | |||
* [[Lamination station]] | |||
* [[Task Tracking]] | |||
* [[Player Packs- GOD]] | |||
* [[Lost property]] | |||
* [[Potions desk]] | |||
* [[Dreams and visions]] | |||
* [[GOD checklists]] | |||
== Online processes == | |||
* [[Printing]] | |||
* [[Visions]] | |||
* Bookings and payments | |||
** [[Bookings]] | |||
** [[Taking payments]] | |||
** [[Confirming concessions]] | |||
* [[Player accounts]] | |||
** [[Character processes]] | |||
* [[Magic | Magic (including Rituals)]] | |||
* [[Religion | Religion (including Ceremonies)]] | |||
* [[Ribbons]] | |||
* [[Glossary]] | |||
== Editing this manual == | == Editing this manual == | ||
* | * '''Give pages clear, unambiguous, non-conflicting names'''. This may require some careful wordsmithing as we're operating in the same namespace as the rest of the crew wiki. The convention for this wiki is for titles to have the first word capitalised only. | ||
* ''' | * '''Try to avoid duplicating existing pages'''. If there's already relevant information in this crew wiki, refer to that rather than duplicating it in another page. Including relevant references to the main player wiki can also be really helpful if someone needs to understand the wider context. | ||
* '''Cross-linking is good.''' Try to avoid repeating yourself – having the same information in multiple places is a good way to have multiple bits of information fall out of sync with each other – and instead write something once and link to it anywhere else it's useful. | * '''Cross-linking is good.''' Try to avoid repeating yourself – having the same information in multiple places is a good way to have multiple bits of information fall out of sync with each other – and instead write something once and link to it anywhere else it's useful. | ||
* '''Make things easy to link to''' by breaking things up into discrete bite-sized chunks. Done well, we should be able to link directly to relevant | * '''Make things easy to link to''' by breaking things up into discrete bite-sized chunks, whether by putting things in different pages or by having good header structure within one that allows for direct linking to a particular section. Done well, we should be able to link directly to relevant details from various parts of the crew website interface, so that the wiki provides effective context-sensitive help for all tasks. | ||
* '''Put all the manual pages in the <code>GOD manual</code> category''' to make sure all pages can be found easily. This is done by putting the code <code><nowiki>[[Category:GOD manual]]</nowiki></code> at the bottom of each page. | * '''Put all the manual pages in the <code>GOD manual</code> category''' to make sure all pages can be found easily. This is done by putting the code <code><nowiki>[[Category:GOD manual]]</nowiki></code> at the bottom of each page. | ||
| Line 30: | Line 80: | ||
* '''Document the 'why' as well as the 'what''''. There are competing goals to everything we're writing here: we want things that are quick and easy and straightforward to follow, and we ''also'' want to document why we do things the way we do them, so if we want to change things in future we have half a chance of understanding why things are the way they are now. Consider having separate sections in any process documentation for (a) a process overview for folk who know what they're doing but want a reminder of some specifics, (b) a detailed step-by-step guide for folk who aren't familiar with the process, and (c) a final section explaining the reasoning behind anything that isn't obvious. | * '''Document the 'why' as well as the 'what''''. There are competing goals to everything we're writing here: we want things that are quick and easy and straightforward to follow, and we ''also'' want to document why we do things the way we do them, so if we want to change things in future we have half a chance of understanding why things are the way they are now. Consider having separate sections in any process documentation for (a) a process overview for folk who know what they're doing but want a reminder of some specifics, (b) a detailed step-by-step guide for folk who aren't familiar with the process, and (c) a final section explaining the reasoning behind anything that isn't obvious. | ||
[[Category:GOD]] | |||
[[Category:GOD manual]] | [[Category:GOD manual]] | ||
Latest revision as of 15:35, 11 September 2024
About this manual
"In the beginning, there was nothing. Which exploded." Terry Pratchett, "Lords and Ladies"
The GOD manual tells GOD crew how to do things. It's the repository of knowledge that describes the majority of processes that are followed at (and occasionally between) events.
⚠️Caution
This wiki is publicly accessible. The vast majority of things that GOD do are fine to publish here, but be careful not to reference details of plot that aren't generally available. You can talk about the existence of (say) chaos fruit, since that's available on the player wiki, and you can talk about how we organise them and print them, but don't give any details about how they work from a plot or game mechanic perspective. Equally, if you want to provide screenshots or similar, make sure you don't use a real player account; use Crew Room (PID 0) or Ref Dummy Character (CID 0.1).
Introduction
Background
- Relevant information from the crew wiki:
- Empire resources
Event specials
- Future
- Past
Physical processes
- GOD physical organisation
- Lamination station
- Task Tracking
- Player Packs- GOD
- Lost property
- Potions desk
- Dreams and visions
- GOD checklists
Online processes
- Bookings and payments
Editing this manual
- Give pages clear, unambiguous, non-conflicting names. This may require some careful wordsmithing as we're operating in the same namespace as the rest of the crew wiki. The convention for this wiki is for titles to have the first word capitalised only.
- Try to avoid duplicating existing pages. If there's already relevant information in this crew wiki, refer to that rather than duplicating it in another page. Including relevant references to the main player wiki can also be really helpful if someone needs to understand the wider context.
- Cross-linking is good. Try to avoid repeating yourself – having the same information in multiple places is a good way to have multiple bits of information fall out of sync with each other – and instead write something once and link to it anywhere else it's useful.
- Make things easy to link to by breaking things up into discrete bite-sized chunks, whether by putting things in different pages or by having good header structure within one that allows for direct linking to a particular section. Done well, we should be able to link directly to relevant details from various parts of the crew website interface, so that the wiki provides effective context-sensitive help for all tasks.
- Put all the manual pages in the
GOD manualcategory to make sure all pages can be found easily. This is done by putting the code[[Category:GOD manual]]at the bottom of each page.
- Document the 'why' as well as the 'what'. There are competing goals to everything we're writing here: we want things that are quick and easy and straightforward to follow, and we also want to document why we do things the way we do them, so if we want to change things in future we have half a chance of understanding why things are the way they are now. Consider having separate sections in any process documentation for (a) a process overview for folk who know what they're doing but want a reminder of some specifics, (b) a detailed step-by-step guide for folk who aren't familiar with the process, and (c) a final section explaining the reasoning behind anything that isn't obvious.