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

Conceptual guide: Best practices for data visualization using Altair #3117

Open
mattijn opened this issue Jul 22, 2023 · 0 comments
Open

Conceptual guide: Best practices for data visualization using Altair #3117

mattijn opened this issue Jul 22, 2023 · 0 comments

Comments

@mattijn
Copy link
Contributor

mattijn commented Jul 22, 2023

While working on #3021 (preview here) I got a bit stuck in writing.

I realized that there basically is a difference between documentation that explains how to do things and documentation that explains why you should do certain things. When these two aspects are integrated into a single page, eg. demonstrating how to change color schemes and explaining the significance of selecting appropriate colors you get a single very lengthy page.

I think this is another example (other) of how docs are used differently at study and at work.

After reading a bit more on systematic approaches of writing technical documentation, (this website was very interesting) and discussing this topic a bit more with @joelostblom and my not-yet-on-github-colleague Michelle Rudolph, we think it could be interesting to add a section in the documentation on best practices for data visualization using Altair.

Note

Diátaxis uses the term Explanation but says they are interchangeable

The current User Guide has a section navigation with two items. We think it might be worth discussing to add another section so it becomes:

  • How-To Guide (this is currently titled User Guide)
  • Conceptual Guide (new)
  • Advanced Usage (same)

Time-wise its not really possible to have a single PR with a complete new section in the docs, so it's probably best to approach this iteratively. Maybe starting with a skeleton structure that slowly can be filled in.

@dangotbanned dangotbanned changed the title Add a conceptual guide in the docs on the best practices for data visualization using Altair Conceptual guide: Best practices for data visualization using Altair Jan 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants