Skip to content

Add information architecture heuristics to process documentation #704

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

ADubhlaoich
Copy link
Contributor

Proposed changes

This pull request adds a document describing ten information architecture heuristics that can be used to assess information architecture and overall content design. It is an adaptation of work by Abby Covert.

This document does not include rating criteria, which tend to be subjective - these are largely intended for discussion and planning points. Assigning ratings can be handled separately as part of a prescriptive process for managing information architecture.

There will likely be follow up work to point to live examples to illustrate individual heuristics.

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content.

This commit adds an IA heuristics page to our process documentation. The
NGINX DocOps teams spends a lot of time engaged with IA and is
increasingly involved with using heuristics to assess content.

This gives us a baseline of shared parameters and vocabulary for efforts
going forward.
@ADubhlaoich ADubhlaoich requested a review from a team as a code owner June 18, 2025 16:11
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/704/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant