Administrator's manual TODO

Some thoughts on how we could improve the [[administrator's manual][http://code.alaveteli.org/running/admin_manual/]].

There is also an ongoing moderators manual on Google Docs being made for AsktheEU, but can probably be adapted to other sites. https://docs.google.com/document/d/10Tzi5FXXYwBtpxS9-m7M_NuFm0IHzQneshH6EI7q4pM/edit

Some notes on how we should improve documentation:

• problem-oriented documentation
• tutorial format, use screenshots, step-by-step.
• Videos + voiceover, i.e. show what you're doing and talk about why
• provide explanations of why, not just how

An ideal admin manual entry contains:

1. Write a problem or task description, e.g. "I want to edit messages"
2. Why would you want to do this, e.g. "The message contains potentially defamatory text"
3. From the beginning (including things like "login as admin"), step-by-step guide to solving the problem, e.g. "Try a censor rule then use the edit request button if that fails" (but in much more detail!)
4. Add screenshots; make arrows, circle things etc to make it obvious what you are talking about
5. Consider making a video

Things we would like to be documented

• Handling holding pen messages (already in the AskTheEU manual)
• Retrieving information from the raw email (i.e. download it or whatever; email client specific)
• How to read email headers
• Moderation
  • Editing requests - censor rules and the like
  • Hiding/editing annotations
• Authority maintenance
• User management
  • Forgotten login/password
  • Can't register: WDTK has policy of just approving them: need to tell the user that they've now been approved
  • Making superusers
• Other site management stuff
  • Consider setting up mail lists - at least a team@; tell everyone to use reply-to header and to reply-all when replying