: 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

@Hamaas631

Vote Up Vote Down

There are two general approaches, depending on the amount of detail you need from the "other" concept.

If you don't need a lot, write about subject A, and when the first interaction with B hits add a parenthetical sentence, call-out note, or footnote (depending on your style guide) describing the other concept and pointing to its main documentation. For exmaple:

To configure a subscription, do (blah blah blah) and specify the callback URL. (A callback is a service you write that this service will call with updated data. See Section X.)

If the topics or their inter-connections are more complicated, the other approach is to write a brief overview that introduces all the concepts. Think of this as breadth-first documentation. The overview should point to the more-detailed documentation on each topic.

(0)

Login to post a comment!