Skip to main content

Best Practices

  • Include correctly attributed photos & PDFs
  • Include sources whenever you’re being factual
  • Mark incomplete information as such, either with a warning or “WIP” in the title/heading
  • See a problem but don’t want to/can’t edit it right now? Make a comment on the page suggesting an edit.
  • Empty and incomplete pages are GOOD things. They prompt dialogue and contribution. 
  • Wiki pages should be accessible:
    • Avoid walls of text, request a post-draft editor if you’ve got something to share but writing isn’t your strong suit. Use the structures available to break up the text into manageable chunks and to signpost readers to the right information. Structural formatting also helps screenreaders (tools for visually impaired people to access computers & the internet) navigate the page.
    • Always write alt text for images
    • Don’t rely on colour as the only way to convey something, double that up with text or icons
  • Avoid link shorteners, but do try to fit links smoothly into the text by using link text.
  • Tag every page, chapter, book with as much as you think is relevant
  • Keep content relevant to the Hackspace, we're not documenting the universe, just our corner of it
  • Never present someone else’s content as your own, always attribute the original author/creator/maker
  • Never rely on AI for fact or accuracy. If you don’t know it yourself, find a trustworthy source for evidence. Ask someone else to confirm the reliability of the information if you aren’t certain.
  • No AI created images, not any, not ever.
  • Don’t include identifying personal information anywhere on the wiki, not even your profile.
  • Don’t add any information it is illegal to disseminate to the public
  • Absolutely no NSFW content 
  • Don’t use the Markdown editor unless you know what you’re doing, and always use the “stable content” option to swap to Markdown for editing existing content.