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

Docs: There is no clear differentiation between Tutorials and How-To Guides #1480

Open
trgeiger opened this issue Nov 18, 2024 · 3 comments
Open
Labels
documentation Improvements or additions to documentation kind/documentation Categorizes issue or PR as related to documentation.

Comments

@trgeiger
Copy link
Contributor

We currently have 2 main categories for our docs named "Tutorials" and "How-To Guides." These are basically synonyms unless differentiated in some way in our documentation.

These should probably either be combined into one category, or else the existing documentation in each category should be re-categorized and one of the 2 categories should be re-named according to some new difference in purpose between the 2.

@rashmi43
Copy link
Contributor

I can take this up once we know which how we want to update it

@m1kola m1kola added documentation Improvements or additions to documentation kind/documentation Categorizes issue or PR as related to documentation. labels Nov 19, 2024
@joelanford
Copy link
Member

My interpretation (I might be wrong) is:

  • Tutorials are for broad, primary use cases
  • How-To Guides are for more niche use cases

Regardless, I do agree that the distinction is not obvious and we should probably try to clarify.

Honestly, I think a primary reason to clarify is so that contributors to the docs have a clear mental model for where to add the next thing.

@trgeiger
Copy link
Contributor Author

Yes, exactly. The way I was thinking about it, I imagine the difference between the two would largely come down to formal differences, which if clarified would help document writers with the style and tone of new contributions. I imagine Tutorials being detailed and thorough walkthroughs of more involved use cases, whereas How-To Guides could be more truncated reference material for shorter, more common commands? But that's sort of opposite of what you describe above as your intuition, so the terminology for the 2 categories probably does need tweaking--even just being much more descriptive with the intent of each category, like "Common Use Cases" and "Uncommon Use Cases" or something. "Long-form Tutorials" and "Common Commands." Definitely worth getting team input.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

No branches or pull requests

4 participants