Stay updated
Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 6,100+ subscribers. (See email archive here.)

Search results

New article in Simplifying Complexity -- Ensuring information harmony in the larger documentation landscape

by Tom Johnson on Mar 7, 2018 •
categories: simplifying-complexity

In the Simplifying Complexity section of my site, I published a new article about how to ensure information harmony across a larger documentation landscape, where other articles might contain similar themes and information. In the article, I dive into two factors that increase complexity in a system: specialization and interconnectedness. Relevant to documentation scenarios, when subject matter experts contribute specialized articles into a larger system without understanding how their individual article interacts with other information in the system, the result is often a redundant, contradictory, and ever-increasing jumble of content. In this article, I explore ways to solve this problem through better metadata, primarily evaluating tags and whether they can help identify all known instances of content. You can read the article here: Ensuring information harmony in the larger documentation landscape.

Sponsored content

Buy me a coffeeBuy me a coffee
Stay current with the latest in tech comm
Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 6,100+ subscribers. (See email archive here.)

follow us in feedly

About Tom Johnson

Tom Johnson

I'm a technical writer / API doc specialist based in the Seattle area. In this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, visual communication, information architecture, writing techniques, plain language, tech comm careers, and more. Check out simplifying complexity and API documentation for some deep dives into these topics. If you're a technical writer and want to keep on top of the latest trends in the field, be sure to subscribe to email updates. You can also learn more about me or contact me.

Comments
https://idratherbewriting.com/2018/03/07/ensuring-information-harmony-in-doc-landscape/
idratherbewriting.com
crawl=CC-MAIN-2022-40
38222
application/http; msgtype=response
sha1:CN35BFYG6PZWIEV4DL2UAIJWCW7TLYEQ
<urn:uuid:6e4cb588-5c5d-47ca-8a91-8df2521bbf27>
2022-10-03T08:19:54Z
172.67.164.13
text/html
sha1:LHWNJXACV3MGYV7XVW5OL5CCPWFVXSTM
<urn:uuid:8c8f064d-b8e7-4385-95ed-d5825a0f168a>
https://idratherbewriting.com/2018/03/07/ensuring-information-harmony-in-doc-landscape/
response
<urn:uuid:16da6bd9-5b10-424d-aa31-f15e1fe2b4ad>
isPartOf: CC-MAIN-2022-40
publisher: Common Crawl
description: Wide crawl of the web for September/October 2022
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-116
software: Apache Nutch 1.19 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.4-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/