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

Information architecture experimentation. #348

Closed
wants to merge 6 commits into from

Conversation

jhkrug
Copy link
Contributor

@jhkrug jhkrug commented Jan 31, 2024

DO NOT MERGE. Experiment only.

See if this is going to be a useful direction for us.

Trying ideas in the docs to allow exploration of the structure of the docs so a learning path can be plotted by a user (the personas) of the docs.

To have ways apart from the Diataxis sidebar layout to navigate the docs. By persona, by topic, etc. To provide exploration and learning paths.

The idea would be that the entire 'Documentation architecture' hierarchy and content can be programmatically generated. But it can be much simpler than that. What provides the best value solution?

Please take a look at the preview.

https://deploy-preview-348--silly-bunny-8cedd0.netlify.app/next/info-arch/ia

@jhkrug jhkrug added the area/documentation Improvements or additions to documentation label Jan 31, 2024
@jhkrug jhkrug self-assigned this Jan 31, 2024
Copy link

netlify bot commented Jan 31, 2024

Deploy Preview for silly-bunny-8cedd0 ready!

Name Link
🔨 Latest commit 6b54cad
🔍 Latest deploy log https://app.netlify.com/sites/silly-bunny-8cedd0/deploys/65bcb5fcbfd52d0008a26ec4
😎 Deploy Preview https://deploy-preview-348--silly-bunny-8cedd0.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@jhkrug jhkrug mentioned this pull request Jan 31, 2024
74 tasks
@@ -0,0 +1,23 @@
---
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't seem to find or visualize the pages that relate to docs/info-arch/doc-types/*. In my opinion, maybe they aren't needed, docs/info-arch/ia.md can explain the types, and if they have several sections then the sections should be self-explanatory on the sidebar. If we create an index per Diataxis section, I feel they will be missing entries in the long run.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, I misunderstood where to find them, they are linked from the headers of docs/info-arch/ia.md.
I'm not sure it's easily discoverable that way. I would prefer a link after the section header.


## Glossary

Should we have one of these? A set of key terms and their definitions.
Copy link
Member

@viccuad viccuad Feb 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm ok with both an index/glossary/word cloud, sounds like a feature request issue. On my view, it has low priority though.

@jhkrug
Copy link
Contributor Author

jhkrug commented Feb 8, 2024

Leaving this with no status for a while. I will use some aspects of this again after the /docs reorg/new sidebar/ is complete.

@jhkrug
Copy link
Contributor Author

jhkrug commented Apr 30, 2024

Closing this now. A new task #400 is created to carry persona paths forward. A glossary is being experimented with in #394.

@jhkrug jhkrug closed this Apr 30, 2024
@jhkrug jhkrug deleted the info-arch branch April 30, 2024 12:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants