Creating a Status Wiki for User Stories, ADRs, Specifications and Anything Else We Could Imagine

Proposals
2

Follow-Up: Status Wiki Decision & Next Steps

After several discussions and considering different options, we’ve decided to create a GitHub-based wiki as our documentation hub. You can find it here:

:pushpin: Status Wiki

This approach keeps things lightweight, integrates well with our existing GitHub workflows, and ensures easy access and version control.

We’ll start by populating it with key documents, including User Stories, ADRs, and Specifications, and refine the structure as we go. If you have ideas for additional content or improvements, feel free to contribute!

Next Steps

  1. :white_check_mark: Assess the sentiment of the whole team - We’ve decided to move forward with a GitHub-based wiki instead of a MediaWiki installation.
  2. :wrench: Set up the GitHub Wiki - The wiki is now live at Status Wiki.
  3. :open_file_folder: Define an initial structure - Establish clear categories for User Stories, ADRs, and Specifications, make sure they are easy to navigate and reference.
  4. :rocket: Trial with basic content - Start by adding content that lacks a proper home, such as ADRs, to validate the structure and workflow.
  5. :mag: Confirm usability & address issues - Identify any friction points in navigation, contributions, or referencing external docs, and adjust as needed.
  6. :bookmark_tabs: Migrate or link existing documentation - Move relevant documentation from Notion and other platforms or establish references where migration isn’t practical.
  7. :mega: Encourage team adoption - Create contribution guidelines and ensure the process remains lightweight and accessible.

Let me know if you have any thoughts or feedback. Looking forward to building a well-structured and useful knowledge base together! :rocket:

1 Like