![]() They use the search term "export" and see the search result "Export by filename" for an API reference page. The reader could be looking for an API that exports a file. A reader might think they know what to search for, however what if they could discover alternate product functionality that better addresses their needs? A good example of discoverability benefits can be seen in an API reference example. Modular content enhances the discoverability of content. While topic-based writing aims to have all you need to know in one article or page, modular-based content aims to organize and relate content based on your organization's chosen categories. Categories can be based on product functionality, training goals, user roles, or user journeys to name a few. It is mostly about organizing content based on a category. ![]() Assembling and reusing blocks of content into a meaningful organization. Modular content supports discoverability and exposes relationships that glue individual topics and content together and provides navigable sign posts to readers. If you think about agile and writing sprints, they also have a modular aspect, so you can even manage technical writing projects using a modular process. Each can be separated and considered a module of sorts because they are interchangeable. It also encompasses each aspect of defining and building the content, whether it be defining style sheets, creating templates, or using conditions to include or exclude content. And modular content doesn't stop at the literal content the user reads. However, modular content adds relationships and organization that assembles individual pieces of content into cohesive narratives that can be used to perform more complex activities or user journeys. So what is modular writing? At the basic level it seems pretty similar to topic writing. Modular content provides the framework for content relationships and focused navigation paths, without giving up search. ![]() While search is the foremost method for discovering content, modular content, based on a well thought out content model, adds a great second method. However, the reality is that we cannot serve all readers with just one method for retrieving content. Most people go to content when they need to find a solution to a problem that they are currently experiencing.Īs a technical writer, I want to believe that I understand exactly what kind of material the reader needs. In addition, The Docs Team supports software startups with an out-of-the-box, virtual, on-demand technical publications and content strategy team.Įver find yourself going down a rabbit-hole looking for the content you need? Topic writing, which should provide everything you need about a single topic, can produce an indecipherable web of links that leaves you lost. Una is a director of The Docs Team, which specializes in converting all types of legacy content to MadCap Flare. Most recently, Sean’s work focuses on user experience design in environmental communication, where his central concern is understanding how best to communicate complex science information to drive personal conservation behaviors and effect public policy changes.This guest blog post was written by Una Cogavin, a certified MadCap Advanced Developer and MadCap Flare consultant. His industry work ranges from participating as a co-founder in three technology startups, to authoring documentation for the pharmaceutical industry, to architecting a complex healthcare information database. In addition to his work in higher education which accounts for three books, scores of scholarly articles, invited presentations, and an international research fellowship in Barcelona, Sean has worked as an industry consultant and contractor for 25 years. Williams, PhD is Professor and Director of the Technical Communication and Information Design program at the University of Colorado-Colorado Springs, one of a handful of stand-alone technical communication programs in the United States.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |