Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • IA (Information Architecture): Although we have a tons ton of content, accessing it is challenging due to difficulties in difficulty finding the necessary information.

  • Spaces: Currently, we have three spaces, which might cause confusion for readers. Merging these spaces into one , or organizing them logically , will make the documentation more easily accessible.

  • Old Content: We've been in existence for over 20 years, and during this time, we've accumulated a vast amount of documentation. While this is beneficial, it also means that as we evolve must , most content become becomes outdated. Separating the new from the old will make our docs more relevant to the implementers.

  • Look & Feel: Improving Improve the user experience of the docs so new implementers can access them more easily.

Plan

  • Week 1:

    • Tuesday: Meet with UX lead; discuss IA plans, bring IA ideas

    • Wednesday: Meet with Backend/Platform lead & team

    • Thursday: Join the O3 Squad call, share project and invite thoughts, intro self

  •  Put a team together that’ll separate outdated content.
  •  Crosscheck this content with Grace/ to know the content to be archived.
  •  Create Archive space for outdated content.
  •  Use the new outline to structure docs.
  •  Identify & rewrite pages that are poorly written

Resources