documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Audit functions guides and tutorials

Open javabster opened this issue 8 months ago • 3 comments

Now that we are moving tutorials into the docs site, there is some concern that the functions guides and tutorials are quite similar. We want to make sure users aren't confused by which content to look at so we should do an audit and try to de-duplicate.

Guides should primarily be focused on highlighting features and how to use them whereas tutorials should focus on using combinations of features to achieve a goal/use case.

cc @pandasa123 @nathanearnestnoble @miamico

javabster avatar Apr 24 '25 14:04 javabster

Thanks for opening this issue! One initial thought: This extends beyond function guides. I have been operating with the view that "tutorial shows entire workflows" and "guides show a particular step".

As discussed, this gets blurred for the application oriented functions as they inherently demonstrate an entire workflow. I think it is mostly in the "example" section (examples: q-ctrl optimization, qunasys quri chemistry)

However, this is also true for some of the addons. Example SQD, OBP, circuit cutting

My main concern is discoverability for users who are not intimately familiar with platform and having similar content in different locations. Some of the guides vs tutorial are clearly different, while others are very similar.

nathanearnestnoble avatar May 02 '25 14:05 nathanearnestnoble

cc @miamico @pandasa123

javabster avatar May 15 '25 14:05 javabster

As discussed, this gets blurred for the application oriented functions as they inherently demonstrate an entire workflow. I think it is mostly in the "example" section (examples: q-ctrl optimization, qunasys quri chemistry)

I agree with Nate on this point. In many of the Applications functions the part of the guide which begins with the "Get started" or "Example" section works effectively as a tutorial. This is particularly true for the qunova and qunasys ones for which the guide shows the same example of the tutorial. It's unclear then what is the benefit of having a separate yet duplicated tutorial in such cases.

miamico avatar May 19 '25 20:05 miamico

After discussion, what we ended up doing was moving the functions tutorials to their own dedicated section in the website. If we decide to revisit the content I'll open another issue.

kaelynj avatar Jul 14 '25 18:07 kaelynj