(Translated by https://www.hiragana.jp/)
⚓ T327319 Redesign Cloud Services documentation information architecture
Page MenuHomePhabricator

Redesign Cloud Services documentation information architecture
Closed, ResolvedPublic

Description

There are subtasks tracking this project for the Toolforge docs and the Cloud VPS docs. The overall project work remains as originally outlined in this task, for each of the two doc collections:

  • Define critical user journeys for Cloud Services end users
  • Design new information architecture for documentation
  • Content audit and tracking of needed doc revisions, to be either completed by tech writer or filed as phab tasks for others to pick up
  • Identify necessary landing pages and how to improve entry points into the Toolforge, Cloud VPS, and other content collections currently covered by the Cloud Services docs.
  • Get feedback from stakeholders
  • Implement new navigation templates on-wiki
  • Revise / create landing pages
  • File tasks for remaining doc revisions needed

See task updates below for more details!

Related Objects

Event Timeline

TBurmeister created this task.
TBurmeister added a project: Goal.

Work on this has gotten delayed by the need for a consistent framework to figure out which types of doc collections need landing pages, and what type of content should go on those landing pages: see T338379. I don't want to propose a set of portals or a doc structure for Cloud docs and then end up having that be misaligned with what ends up being a larger doc strategy that spans teams/products. The data access content is an example of where improving the overall content navigation experience involves work beyond just the Cloud Services docs.

Status update:

  • [first round of design work done; need to clean-up/finalize proposal docs] Task-focused landing pages for the Cloud Services collection
  • [first round of design work done; need to clean-up/finalize proposal docs] Revised collection structure for the Toolforge docs
  • [started] List of page revisions focused on better alignment with doc types
  • [started] Design work on revised collection structure for Cloud VPS docs
  • [started] Prototyping potential style and content updates for Wikitech entry point (depends on final designs for collection structure and landing pages)

Next week:

  • Share proposal docs and start first round of feedback process with tech writers and WMCS team + stakeholders
TBurmeister changed the task status from Open to In Progress.Jun 28 2023, 5:30 PM
TBurmeister raised the priority of this task from Low to Medium.

Housekeeping note: I'm filing subtasks to more effectively divide up and communicate about the work that is going into this project. The three major areas are:

  1. Entry points into Cloud Services content and how to make them better support users who don't already know our terminology or product offerings:
    • Potential revisions to Wikitech:Main_page
    • Revisions to current Cloud Services landing pages / introduction page.
    • Redesign of navigation template(s).
  2. Toolforge doc collection improvements T341364:
    • New navigation structure (nav template)
    • Revised landing page content
    • Identification of and creation of well-scoped phab tasks for all other non-landing-page doc work.
  3. Cloud VPS doc collection improvements T341366:
    • New navigation structure (nav template)
    • Revised landing page content
    • Identification of and creation of well-scoped phab tasks for all other non-landing-page doc work.

Status update:

  • Met with tech writers to get feedback and iterate on proposed content structure and landing pages
  • Continued work on content audit: gathered Toolforge docs that aren't in the current nav template, added more content to tracking spreadsheet to help 1) ensure continuity in Dev Portal, 2) make it easier to diff the current vs future nav template contents and 3) avoid creating duplicate Phab tasks for docs work that already has a task
  • Phabricator housekeeping both at the project level and individual doc task level
  • Got some questions answered from WMCS team to help with finalizing of the content structure draft

Next steps:

  • Update prototypes and design docs based on feedback and recent design decisions
  • Schedule presentation and feedback sessions with WMCS team
  • Finish content audit for Cloud VPS docs

Status update:

  • Met with WMCS team and got feedback on designs
  • Revised designs
  • Updated design docs and shared the revisions
  • Planning to put designs on-wiki and start feedback round with larger community next week

Status update:

Status update:

  • Revisions for remaining Toolforge landing pages (About_Toolforge, Quickstart) are published and being reviewed.
  • Category metadata for programming languages and tutorial docs applied and How_to doc updated to point to those category pages instead of being manually maintained.
  • Identified and resolved issues with account creation content being duplicated and inconsistent across these and other wikitech docs (T346384)
  • Returning to Cloud VPS content: finalizing IA for new navigation menu; filed tasks for updates to landing pages (Help:Cloud_VPS and Portal_Cloud_VPS).

All planned doc revisions and IA work is complete; I'm wrapping up filing phab tasks for doc work I identified as part of my content audit, but which was out of scope for this project. Those doc tasks are gathered under T203131, as well as being tagged appropriately.

The only remaining work is to create a summary of what this project achieved and publish it on wiki, along with some pointers to orient future doc improvers to these collections (T347641).

Project summary slides (Google slides link accessible to WMF only, I will create a public version on Commons when I start my workday tomorrow).