alkemio icon indicating copy to clipboard operation
alkemio copied to clipboard

Platform documentation

Open SimoneZaza opened this issue 1 year ago • 0 comments

Description

As our user base is growing, so is the need for proper (help) documentation on the platform. Preferrably this is fully integrated on the platform - not the website.

A couple of other needs:

  • Supports multiple languages ((semi-)automatic translations of course would be amazing, but not necessary), maybe we could have a crowdin integration?)
  • Easy for the user to navigate, understand where they are, with a clear tree view on the left
  • Easy for the Product team to manage the content
  • Easy to implement visuals in the content

Quick mockup:

Image

Options to explore:

  • Docusaurus: https://docusaurus.io/docs
  • Mintlify: https://mintlify.com/
  • Gitbook (open source?): https://www.gitbook.com/ - https://github.com/GitbookIO
  • Bookstack: https://www.bookstackapp.com/

Initiative / goal

Improved user experience, improved content on the platform by the users, less support requests

Acceptance criteria and must have scope

Define what is a must-have for launch and in-scope. Keep this section fluid and dynamic until you lock-in priority during planning.

Stakeholders

Describe who needs to be kept up-to-date about this Epic, included in discussions, or updated along the way. Stakeholders can be both in Product/Engineering, as well as other teams like Customer Success who might want to keep customers updated on the Epic project.

Timeline

What's the timeline for this Epic, what resources are needed, and what might potentially block this from hitting the projected end date.

SimoneZaza avatar Feb 19 '24 13:02 SimoneZaza