Information Architecture for Technical Writing

When it comes to technical writing, information architecture means organizing and structuring the content in a way that helps the users. Given that there is a massive volume of content on a particular user manual, the information architecture should assist the users to understand the surroundings and what they are looking for.

Users are able to find information easily and fast if documentation has a good information architecture. If it is difficult or takes time to find information as Tech Writers we need to definitely reconsider the information architecture.

Few advantages of good information architecture:

• Reusable for numerous scenarios. Ex. training new users, new writers.
• Reduce the learning curve as the information is easily available.
• Promote collaboration among authors
• Easily discoverable on the internet.

Information Architecture consists of Classification of hierarchy, Labelling and tagging, Navigation system and Searching.

When designing the information architecture, we need to consider the user types. These could be beginners, intermediate or expert users. Figure out who the users are and what they need to solve. We need to get to know the user before defining the structure.

Then define the content model. The content can be concepts, tasks, or references. Beginner users may look for concepts while Intermediate and Expert users will directly follow the tasks and references. Or this could be App developers, API consumers, or end-users. Understanding personas will help us identify the use case. We can decide the deliverables based on the above.

Now create the content map. Figure out the topics and their levels. Map each topic against the type of the user and based on the context. Now you have a basic idea of the content structure.

Different content types/topics require different templates. Such as release notes, how-to guides, troubleshooting guides, developer guides, API documentation should have their own template.

Navigation; think about how the users will run through the content. This is one of the crucial things in information architecture. Get to know the users and think like the users. Then think about how they would search for things and what keywords they will use. When implementing the Search feature for the documentation always ensure that you evaluate these facts and produce quality content for the readers.

Review and apply feedback from users. Be open to feedback and listen to the users. The users may not always say what they want, this is why the writers need to be empathetic and think like the users to understand the explicit requirements. Constantly managing a documentation space and improving the information architecture will benefit both users and writers.

See the page below for a sample information architecture:

• The left pane consists of the content hierarchy for that particular section of the document.
• The right pane consists of a table of content for the particular page.
• The page content is limited to the middle of the page.
• The minimalistic design and white space.
• Notice how the level topics are categorized.
• A site search is available in the top right corner.

These will improve the user navigation and clarity of the documentation.

When preparing your next technical documentation, follow these easy steps and compile an easy to digest information architecture for a better user experience.