Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create the structure for our documentation #478

Open
dmohns opened this issue Dec 16, 2024 · 0 comments
Open

Create the structure for our documentation #478

dmohns opened this issue Dec 16, 2024 · 0 comments
Assignees

Comments

@dmohns
Copy link
Contributor

dmohns commented Dec 16, 2024

As a first step, we need to establish how we want to structure the documentation. Currently we distinguish between Technical Documentation and Usage Guide, please review if this makes sense.

Goal:
Goal of this task is to create the "outline" of how our documentation should be structured. Please bear in mind the experiences we gained from our user interviews. I.e. what information is most relevant to API Users vs non-API Users

Few ideas/pain points that has been discussed in the past:

  • lot's of duplication in the docs
  • not a clear separation between different "types" of documentation. For example: theoretical descriptions mixed with integration docs

Side note:

As by-product of this task there will arise future to-do, for example, we might discover lack of certain documentation. Please create an implementation plan. After it's review we can convert that into actionable tickets.

@divinecharlotte divinecharlotte self-assigned this Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants