Just Write Click

Technical writing with Continuous Integration and docs-as-code

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code
You are here: Home / writing / Info architecture work that sometimes makes my head hurt

February 6, 2008 by annegentle

Info architecture work that sometimes makes my head hurt

  • Most info architects agree – planning for reuse is harder than conditional text. But even conditional text can be difficult, especially if there are multiple conditions that overlap. The winner of the “most conditional text” contest was this commenter on my talk.bmc post with 64 conditions in a FrameMaker document.
  • Author-it has this to say about the business case that would make you think you need conditional text. Apparently you don’t need conditional text, with enough content chunking and reuse. I’m not sure I buy it so it makes my head hurt.
  • I still struggle with topic authoring – but I’m finally “over” separating content from format. Whew! That only took a couple of years. This week I’m chunking of information using the rule of “seven plus or minus two.” That doesn’t usually make my head hurt, until I start coming up with all sorts of scenarios (maybe the user wants to set up their web site pricing for a DVD sale in the month of March!) and then I find myself writing too many topics.
  • I also read Jon Udell’s great post about potential reasons why del.icio.us hasn’t really gone mainstream, Discovering versus teaching social information management.  I think my own tag merging and pruning best practices need work.  My favorite lines are from the comments, such as “people need to both realize that they can do that database query, and that they can refer to the results using a stable URL. I’m coming to believe that both those operations are still way beyond the capabilities of mainstream web users.”
  • And finally, inline linking versus grouping links together. Usability studies and experts disagree on the correct way to link. I’m not sure I have the answers yet either. Better keep studying and linking.

What are some aspects of information architecture that are making your head hurt lately?

Related

Filed Under: writing Tagged With: del.icio.us, information, tagging

More reading

Bubble graph showing sources of developer support data

I’ve been thinking a lot about developer support at Cisco recently, especially for the way the world works today with multiple cloud providers. This post is a re-publish of my talk from over five years ago, but the techniques and tools for listening and helping others are still true today. At Rackspace, we watched several […]

Cisco DevNet is our developer program for outreach, education, and tools for developers at Cisco. From the beginning, the team has had a vision for how to run a developer program. Customers are first, and the team implements what Cisco customers need for automation, configuration, and deployment of our various offerings. Plus, the DevNet team […]

I had a great talk with Ellis Pratt of Cherryleaf Technical Writing consulting last week. Here are the show notes, full of links to all the topics we covered. Podcasts are great fun to listen to and participate in, if a bit nerve-wracking to think on your feet and make sure you answer questions succinctly […]

At the beginning of this year, I worked hard to summarize my thoughts on API documentation, continuous publishing, and technical accuracy for developer documentation. The result is an article on InfoQ.com, edited by Deepak Nadig, who also was forward-thinking in having me speak to a few teams at Intuit about API documentation coupled with code. Always […]

Recently on Just Write Click

  • A Flight of Static Site Generators: Sampling the Best for Documentation
  • Try a GPT about “Docs Like Code” to ask questions
  • Discipline and Diplomacy: Docs in the Open
  • Let’s Find Out: When Do Static Site Generators Do Rendering?
  • GitHub for Managing Tech Docs

Just Write Click in your Inbox

Enter your email address to subscribe to Just Write Click and receive notifications of new posts by email.

Read More

  • Privacy Policy
  • About Anne Gentle, developer experience expert
  • Books by Anne Gentle
    • Conversation and Community
    • Docs Like Code, a Book for Developers and Tech Writers
  • Woman in Tech Speaker Profile
  • Contact

Books

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code

Copyright © 2025 · WordPress · Log in