![]() ![]() Finally, go through each space deleting those pages with labels that don't pertain to the given variant. When it's time to publish the content, copy the entire space to multiple spaces, each named for a different variant. On each page, you add a label designating the variant to which it relates. In the example, you would have a "Getting Started" page for users and a "Getting Started" page for admins. To implement this approach as part of your content strategy, you could create the content for all variants in one space. This provides a better experience for users than keeping all variants in one space, since they only see content related to their use case. From each space, you can publish exported documentation in specific variations and have different help site URLs for each variant. To separate different variants of your documentation, you could use multiple spaces to publish the variations separately. With the Expand macro approach, users of less used variants must pay very close attention to find and expand the additional content.Increased documentation overhead, as you'll have to copy shared content to ensure it's updated between all variants or ensure visible and hidden content is updated and makes sense together.Reduced content and navigation skimability.For example, the content on the "Getting Started" page is targeted at users and the Expand macro is titled "Additional Information for Administrators". Title the Expand macro(s) to designate for which variation it's intended. Add one or more Expand macros with varied content on the page.For example, the headings on the page could be: "Getting Started - User" and "Getting Started - Admin". Create a section for each variation within one page separating variants by section.For example, the pages could be titled: "Getting Started - User" and "Getting Started - Admin". Create a page for each variation within one space separating variants by page title.Here are a few ways you could implement this to help manage your content: This approach is simple to do and viable in situations where you have a small amount of documentation with little content variation. You can use Expand macros to hide content variations by default. So you're writing a user and administrator variant. For each type of person, you write different overviews, steps, etc. To look at these two approaches, consider this example: your team writes a documentation guide for users of your product and a guide for administrators. When thinking about your content strategy, there are two options for handling variants of similar content are to display varying content in the same space, or in different spaces. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |