Questions tagged [information-architecture]

This tag should be used for questions that are related to writing in a technical environment with a focus on architecture, such as when asking about how you could document a complex hierarchical system or creating a userguide for a bigger system.

Filter by
Sorted by
Tagged with
5 votes
2 answers

For HTML documentation sets, are there meaningful guidelines for topic length?

We produce a large HTML documentation set with the conventional two-pane view: expandable table of contents on the left, selected topic on the right. When you select a topic, if it has subtopics -- ...
Monica Cellio's user avatar
3 votes
1 answer

How do I mix linear and non-linear "choices" in an interactive novel?

In my interactive novel, I'm trying to keep the word count between choice prompts fairly short and consistent, but that means sometimes breaking up longer text into a few sections…. I've been using ...
wetcircuit's user avatar
  • 27.2k
12 votes
3 answers

How to effectively document a product composed of complex microservices?

I have a highly flexible software product consisting of a series of loosely coupled microservices. Each component is effective at a single job, but may be dependent on inputs from other services. It ...
Jason Fox's user avatar
  • 477
9 votes
2 answers

How should I document a database schema?

I am going to be writing some user-facing documentation for a database that visitors can query. That is, the people writing queries are not the ones who created the database; they can come in, look ...
Monica Cellio's user avatar