: Re: How to write about things which depend on each other I am writing a technical documentation about a product. Now problem is there are many interrelated and interdependent concepts. I am just

@Jamie945

Vote Up Vote Down

Whenever I'm in this situation I leverage the following:

Glossaries: Doing a glossary saves me from bloating a document with detailed explanations on "basic stuff". I instead give a 1 sentence explanation useful enough for the rest of the context. This one liner comes to me after writing the glossary entry and rewriting it several times after.
Metaphors: If one thing is to hard to explain to a target audience, sometimes a supplementary explanation will just do. This works well when the metaphor is replacing other concepts than the central one I'm trying to focus on.
Cross-referencing: Sometimes you just have to explain the whole shenanigan, but rather do it one at a time and provide a link/reference to another section (i.e. "see page X", "read section Y"). Similar to when having to use glossaries, but a glossary entry alone wont be enough.

I use LaTeX and doing Glossaries and cross-referencing is easy as cake.

(0)

Login to post a comment!