- How might documentation be accessible?
- Who needs what kind of documentation?
- How do we limit noise when it comes to searching for documentation?
- How do we encourage good documentation practices?
Policies are things like role descriptions, guidelines, and workflows. Document policies by tagging them #faq (short for frequently asked questions). All #faq s are accessible by clicking on the tag, as well as from the hamburger menu.
Image Description: Screenshot of how to access the FAQ via the hamburger menu. To access the FAQ using only your keyboard, you can open the hamburger menu by using the
=keyboard shortcut, or by using
⌘F + faqto find a #faq link.
You can also
- Turn #faq s into wikis so that people can collaboratively edit the FAQ.
- Add a table of contents which helps with navigation and accessibility.
- Set a topic timer that automatically bumps the FAQ to the top on the date of your choosing, set a bookmark reminder, or make an event, to be reminded when you need to review a policy
- Add Discourse-reply-template-component - theme - Discourse Meta
Document meeting notes by tagging them #meeting-minutes. Use a format that works for you! Here’s a sample one that’s modified from Many Voices One Song: Shared Power with Sociocracy - #4 by TedRau. Key idea is to keep it simple and sweet.
Hi all, please review the meeting minutes and +1 if you consent or reply with your revisions!
- new policies
- operational decisions
Upcoming agenda items:
Next meeting date/time:
Link to full meeting notes:
Every #work subcategory is equipped with a Kanban Board view.
Image Description: Screenshot of Kanban Board view.
The Kanban Board View shows topic titles organized in columns under their respective project management tags.
Use this board to track which tasks are in what stage. Topics can also be marked #blocked, which tells teams that they need to give the blocked task some extra attention in order to unblock it.
To learn more
- Read about the Kanban Board Theme Component on Discourse
- Watch Intro to Kanban in Under 5 Minutes
- Read the Kanban book by David J. Anderson (BetterWorldBooks | Amazon)
By default, we suppress topics in the #projects categories from the summary email. We also hide them from the /latest and /top pages so that people aren’t bombarded by these details. You can override these settings by using notifications. Read Discourse New User Guide: Notifications to learn more. For example, if you want to be notified every time a topic is posted in the #projects:online-forum category, you can choose ‘Watching First Post’ for that tag or category.
Image Description: Screenshot of how you can choose to “Watch” a category.
See YPC Admin Calendar for Details.