Revision as of 14:34, 4 July 2023 by Jmabb (talk | contribs) (→‎Contents)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Introduction

"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.

Historically, the GOD manual took the form of a PDF. As of July 2023, we're in the process of migrating it to this wiki. If you'd like to help, get in touch with Adam. Until that process is completed, you will likely need to check both this wiki and the PDF manual.

⚠️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).

Contents

Editing this manual

  • Create subpages to this one with a name like with names like GOD manual/Potions when you're documenting new things. The exception to this guideline is if the topic is likely to be widely applicable to non-GOD crew, in which case create a new top level page (or link to the appropriate existing one.)
  • 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.
  • 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 pages 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 manual category 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.