Wiki
Documentation portal for IT products
A B2B company that builds IT infrastructure software. I redesigned the documentation portal for seven products: the home page, the product page and the article template, and put together a UI kit and a guide for technical writers. The project is under NDA, so names and content have been changed.
The portal had to help people find their product and the right instruction right away
In the old version, it was hard to tell what the product was: everything relied on the description. To get to the docs, you had to know the section in advance (Documentation, Knowledge base, Troubleshooting), and new users got lost. The portal had no general information about the product, and long instructions were a solid wall of text.
I led the portal from the first interviews to developer handoff.
I started with interviews with the team and technical writers, then reviewed the existing documentation, benchmarked competitors and analyzed click maps. For the technical writers, I wrote a guide on filling in articles.
I reviewed 25+ documentation portals and about a hundred of their screens
I compared how technical products and infrastructure platforms handle navigation, search, content and copy. I rated each feature by how critical it was for our portal and noted what to adopt. Based on this, we built the section structure and the scope of the first version.
- 25+
- documentation portals analyzed
- 50+
- competitor features reviewed
- 20+
- solutions picked for the portal
Home page as a product hub
I turned the home page into a hub for all products: users land in their product right away and don't have to guess which section to look in.
Product page
I gathered general product information on one page and made a single template for it that technical writers fill in for any product.
Article with collapsible steps
I added collapsible steps so long instructions don't have to be split into sections that bloat the sidebar.
Screens under NDA
The project is under NDA, so I can show it and walk you through it in more detail on a call.
