: 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

@Barnes643

Vote Up Vote Down

The only way of not having forward references is to build up everything from the bottom. So you start with a glossary, defining the terms you are going to use. In some cases, these can cross reference to each other, as they will all be in the same area. Then you do your definitions - the basic processes that are involved, again with some cross reference if needed. You can also do "see also" type references to later in the manual, so referring in the definition of a wizzlet process, you can say "for details on how to initiate and configure a wizzlet process, see section 26 below ). This means that peple who want to refer to this for a specific need can follow these through, but it can also be read ignoring this.

Hopefully, by this point, you will be able to write the main bulk of the text, referring back but not forward ( although further see also references might be useful - these are to provide links that are not necessary to follow to understand ).

In your specific case, you would define the principles behind topic 1 and topic 2, with possible cross references if necessary, although if you can avoid them, even better. The detailed interaction of these two is dealt with in the main text.

So, if you need a define Cyclone Bigit, which is created from a Convex Waddle, and the convex waddle only has a meaning as the progenitor of a Cycle Bigit, then you define the meanings first - what is a Bigit? What is a Waddle? Then you define the Cyclone Bigit, irrespective of how it is generated, or what it is for. You also define - irrespective of context - the Convex Waddle.

Once you have these both defined, in a way that is insufficient to use them, but sufficient to appreciate their potential reference, you can explain how you take and define a Waddle and make your Bigit out of it. Hopefully, someone reading it all through will have their understanding taken slowly through the whole process, and grasp what is needed by the end.

(0)

Login to post a comment!