You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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:
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.
The text was updated successfully, but these errors were encountered: