Post History
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 ad...
Answer
#3: Attribution notice added
by
System
·
2019-12-08T02:09:09Z (almost 5 years ago)
Source: https://writers.stackexchange.com/a/4828 License name: CC BY-SA 3.0 License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision
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.
#1: Imported from external source
by
System
·
2012-01-17T14:41:04Z (almost 13 years ago)
Original score: 12